Garden-AI / garden

https://garden-ai.readthedocs.io
MIT License
16 stars 4 forks source link

Global DOI for notebooks #468

Closed MaxTuecke closed 1 month ago

MaxTuecke commented 1 month ago

Fixes #379, #471 and #472

Overview

Adds a new DOI argument for notebook start / publish and makes garden_doi in the garden_entrypoint decorator optional.

Discussion

The new --doi argument allows the user to specify a global DOI in their notebook's metadata that will publish all entrypoints in that notebook to the specified garden without needing to provide each entrypoint with the DOI. The user can still use the garden_doi in the garden_entrypoint decorator to override the global notebook doi and publish an entrypoint to a different garden.

This PR also includes some small bug fixes:

Testing

Fixed test_metadata unit tests to also check for global notebook DOI. Added new idempotency unit tests to check ndarrays.


📚 Documentation preview 📚: https://garden-ai--468.org.readthedocs.build/en/468/

codecov-commenter commented 1 month ago

Codecov Report

Attention: Patch coverage is 59.70149% with 27 lines in your changes are missing coverage. Please review.

Project coverage is 76.52%. Comparing base (3268bb4) to head (60a27fe).

Files Patch % Lines
garden_ai/app/notebook.py 0.00% 14 Missing :warning:
garden_ai/entrypoints.py 70.00% 6 Missing :warning:
garden_ai/scripts/save_session_and_metadata.py 0.00% 5 Missing :warning:
garden_ai/notebook_metadata.py 50.00% 2 Missing :warning:

:exclamation: Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #468 +/- ## ========================================== - Coverage 76.67% 76.52% -0.16% ========================================== Files 51 51 Lines 3336 3382 +46 ========================================== + Hits 2558 2588 +30 - Misses 778 794 +16 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.