Dev#86
Merged
Merged
Conversation
* Initial plan * Initial plan for docstring updates and autodocs reorganization Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Add numpy-style module-level docstring to caskade __init__.py Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update docstrings in base.py to comprehensive numpy-style format Improve or add numpy-style docstrings for public API in Node, Memo, and helper functions. Fix incorrect parameter in graphviz docstring and malformed code example in link docstring. No code logic changes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add numpy-style docstrings to backend.py Add comprehensive numpy-style docstrings to the Backend class, its public methods and properties, the ArrayLike type alias, and the module-level backend instance. No code logic changes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add comprehensive numpy-style docstrings to Param class and valid_shape Add or improve docstrings for all public properties and methods in param.py including valid_shape(), Param.dynamic, Param.pointer, Param.static, Param.node_type, Param.to_dynamic, Param.to_static, Param.to_pointer, Param.shape, Param.batched, Param.batch_shape, Param.group, Param.dtype, Param.device, Param.value, Param.npvalue, Param.cyclic, Param.valid, and Param.is_valid. All docstrings follow numpy-style with Parameters, Returns, and Raises sections as appropriate. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update docstrings in module.py to numpy-style Add or improve docstrings for Module.__init__, all_params, param_order, dynamic, and static properties. All other docstrings were already adequate. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update decorators.py docstrings to numpy-style format - forward: Add long description about parameter passing and activation, reorder sections (Parameters, Returns, Examples) - active_cache: Convert **WARNING** to Warnings section, Note to Notes section, Example:: to proper Examples section, use double backticks for inline code references Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: update context.py docstrings to comprehensive numpy-style Update class docstrings for ActiveContext, ValidContext, and OverrideParam to use numpy-style format with Parameters, Raises, and Examples sections. No code logic changes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add numpy-style docstrings to collection.py Add comprehensive docstrings to NodeCollection, NodeTuple, and NodeList classes including class-level docs, property docs, and method docs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Update docstrings in mixins.py to comprehensive numpy-style Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Convert docstrings in utils.py from Google-style to numpy-style Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * docs: expand error and warning docstrings to numpy-style Update docstrings in errors.py and warnings.py to use numpy-style format with brief descriptions of when each error/warning is raised. Add Parameters sections to classes with __init__ methods. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Expand test() docstring to numpy-style with Examples section Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Add numpy-style docstrings to all caskade classes/methods and reorganize autodocs Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Remove test_graph artifact and add to gitignore Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Final docstring and autodocs update Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Fix gitignore: properly add test_graph and remove artifact Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Address PR review feedback on docstrings for ValidContext, OverrideParam, to_valid/from_valid, and group Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Change "Raised" to "Issued" for warning description Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * more explicit backend reference in autodoc Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * update topological ordering description to mention recursive nature Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Split autodocs into separate TOC pages; move Node/Backend to bottom; update ArrayLike type Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Connor Stone, PhD <connorstone628@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
* Initial plan * feat: add NodeDict collection class for dictionary of nodes Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * test: add dynamic property and update-with-kwargs tests for NodeDict Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * docs: add Node Collections section to AdvancedGuide tutorial Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * clean up node collections in advanced notebook * make setdefault behaviour safer to improper inputs Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * improve code rendering in tutorial notebook Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * include name passed to super in example Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: wrap all NodeList/NodeDict mutation methods in try/finally to ensure re-linking Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * add docstrings, handle setdefault error cases * add popitem test --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> Co-authored-by: Connor Stone <connorstone628@gmail.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
…ents (#79) * Initial plan * Make unlink() with no arguments clear all children Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * Address review: use recursive unlink for no-args, move notebook section Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> * add check for trying to unlink key that isnt a child * make test for unlink missing key --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: ConnorStoneAstro <78555321+ConnorStoneAstro@users.noreply.github.com> Co-authored-by: Connor Stone <connorstone628@gmail.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #86 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 13 13
Lines 1617 1699 +82
=========================================
+ Hits 1617 1699 +82
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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.
No description provided.