[MRG]: Update and include BatchSimulate documentation
#1019
Conversation
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
|
@ntolley What do you think of the backend WARNING here: 0889616#diff-f2780322abf4ffe47adb1211d552f3809ea8e151a810b91230a42a945f08104aR198-R200 ? |
|
Reviewed and looks good. No code changes, just some reordering and improvements to the documentation. Will merge |
carolinafernandezp
pushed a commit
to carolinafernandezp/hnn-core
that referenced
this pull request
Jun 4, 2025
…rolab#1019) * api: promote BatchSimulate to top-level import * doc: clean and publish BatchSimulate api docs * fix: linkcheck broken build with BatchSimulate
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.
This PR does the following:
BatchSimulateto a top-level class befitting its status as a member of the public API. This means that its import is analogous to other public classes: just likefrom hnn_core import Network, you can nowfrom hnn_core import BatchSimulatewithout having to import it strictly from its own module. This puts it on equal footing with the other classes described in the public API https://jonescompneurolab.github.io/hnn-core/stable/api.html . The example script forBatchSimulatehas been updated to include this new import way.BatchSimulateso they display properly on the sphinx build (i.e. the code website).backendoptions which indicate that onlylokyshould be used right now (since the other backends do not work out of the box, see updates to BUG: Re-evaluateBatchSimulatebackends #955).