[issue-240] Update Recorder notes to reflect current implementation#930
Open
lnanduri2005 wants to merge 3 commits intoSharedDevelopmentfrom
Open
[issue-240] Update Recorder notes to reflect current implementation#930lnanduri2005 wants to merge 3 commits intoSharedDevelopmentfrom
lnanduri2005 wants to merge 3 commits intoSharedDevelopmentfrom
Conversation
[ISSUE-923] Add Likitha Nanduri to the Contributors.md file
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Recorder subsystem notes to align the documentation with the current Graphitti implementation and removes older design material that no longer matches how recording works today.
Changes:
- Rewrote
docs/Notes/RecordersNotes.mdto document the current Recorder lifecycle, registration flow, and Xml/HDF5 behaviors. - Added a 2026 entry to
Contributors.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/Notes/RecordersNotes.md | Major rewrite of Recorder documentation to reflect current runtime behavior, registration, and output semantics. |
| Contributors.md | Adds a 2026 contributor entry and fixes formatting on the final line. |
| - `DYNAMIC`: captured once per epoch during simulation | ||
|
|
||
| The Recorder system is capable of capturing a wide range of data types using `std::variant` from C++17. The currently supported data types include: | ||
| The base class itself does not know anything about neuron spikes, NG911 calls, layouts, or connections. It only manages a file name, a logger, and the abstract lifecycle above. |
| 9. After `finish()`, `Core::runSimulation()` calls `simulator.getModel().getRecorder().term()`. | ||
|
|
||
| #### Step 1: Variable Registration in Variable Owner Class | ||
| This means the recorder is initialized before vertex creation and connection setup, dynamic data are compiled once per epoch, final output is produced after the run, and the recorder is terminated explicitly at shutdown. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #240
Description
Updated Recorder documentation to reflect the current implementation.
Changes include:
Checklist (Mandatory for new features)
Testing (Mandatory for all changes)
test-medium-connected.xmlPassedtest-large-long.xmlPassed