Add __all__ Export List to __init__.py #157
Open
spmridula wants to merge 2 commits intosensorium-competition:mainfrom
Open
Add __all__ Export List to __init__.py #157spmridula wants to merge 2 commits intosensorium-competition:mainfrom
spmridula wants to merge 2 commits intosensorium-competition:mainfrom
Conversation
… SpikeInterpolator
- Export Experiment, ChunkDataset, Interpolator - Add module docstring - Add __all__ for explicit public API - Enables 'from experanto import Experiment' usage - Improves IDE autocomplete and discoverability
|
Review these changes at https://app.gitnotebooks.com/sensorium-competition/experanto/pull/157 |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
There was a problem hiding this comment.
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Pull Request: Add all Export List to init.py
Summary
This PR improves the public API of Experanto by populating the previously empty
__init__.pyfile. With these changes, users can now import core classes directly from the top-level package (e.g.,from experanto import Experiment).Changes
Experiment(load and query multi-modal experiment data)ChunkDataset(PyTorch Dataset for training)Interpolator(base class for modality interpolators)__all__to explicitly declare the public API__version__ = "0.1.0"Motivation
The empty
__init__.pyprevented users from accessing core classes via top-level imports. Defining__all__makes the package easier to use, improves discoverability, and clarifies the intended public API.Impact