Repository navigation
update examples, README and CITATION.cff - #22
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates project documentation and example materials to make Perspic easier to install, understand, and cite, including a new examples guide and refreshed notebook content.
Changes:
- Expanded the root README with an overview, installation steps, and a quick-start usage snippet.
- Added
examples/README.mdas a guided learning path across the example notebooks/scripts. - Added a
CITATION.cfffile and adjusted example notebooks (including refactoring CIFAR-10 loader setup code).
Reviewed changes
Copilot reviewed 6 out of 8 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Adds project overview, quick start, installation instructions, and links to examples/tests. |
| examples/README.md | New tutorial-style index for example notebooks, troubleshooting, and file structure. |
| examples/mup_integration.ipynb | Minor notebook edits (execution count and markdown content tweaks). |
| examples/logging_scheduler.ipynb | Adds notebook intro and refactors CIFAR-10 setup into helper functions. |
| examples/cifar10.ipynb | Refactors CIFAR-10 setup into helper functions for reuse. |
| CITATION.cff | Introduces citation metadata for the project. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
KonstiNik
reviewed
May 10, 2026
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
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.
README.md: Expanded with a project overview, installation instructions, usage example, and links to examplesexamples/README.md: Added a short tutoriallike guideCITATION.cff: Introduced a citation file with author metadata, etc...