Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs/log/docstring update #572

Merged
merged 6 commits into from
Dec 5, 2017
Merged

Docs/log/docstring update #572

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
263b22b
• System
jdcpni Nov 30, 2017
2966f43
• System
jdcpni Dec 1, 2017
f11ec55
• Log
jdcpni Dec 5, 2017
d681e33
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
jdcpni Dec 5, 2017
ad06e2d
Merge branch 'devel' of https://github.com/PrincetonUniversity/PsyNeu…
jdcpni Dec 5, 2017
e75fae2
• Log
jdcpni Dec 5, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 6 additions & 5 deletions psyneulink/globals/log.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"""

.. note::
This is a provisional implementation of logging. It has the functionality described below; additonal features
This is a provisional implementation of logging. It has the functionality described below; additional features
will be added and some may be subject to modification in future versions.

Overview
Expand All @@ -25,10 +25,11 @@
of the recorded values, along with the time and context of the recording. The conditions under which values are
recorded is specified by the `logPref <Component.logPref` property of a Component. While these can be set directly,
they are most easily managed using three convenience methods assigned to every Component along with its `log --
`loggable_items <Log.loggable_items>`, `log_items <Log.log_items>` and `logged_items <Log.logged_items>` -- that can
be used, as their names suggest, to identify, specify and track items being logged. The entries of a Log can be
displayed using its `print_entries <Log.print_entries>` method, and returned in a CSV-formatted string using its
`csv <Log.csv>` method.
`loggable_items <Log.loggable_items>`, `log_items <Log.log_items>` and `logged_items <Log.logged_items>` -- that
identify, specify and track items the items being logged, respectively. This can be useful not only for observing
the behavior of Compnents in a model, but also in debugging them during construction. The entries of a Log can be
displayed in a "human readable" table using its `print_entries <Log.print_entries>` method, and returned in CSV and
numpy array formats using its `csv <Log.csv>` and `nparray <Log.nparray>` methods.

COMMENT:
Entries can also be made by the user programmatically. Each entry contains the time at
Expand Down