Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Neptune objects and universal methods covered with docstrings #1309

Merged
merged 12 commits into from
Apr 4, 2023

Conversation

Raalsky
Copy link
Contributor

@Raalsky Raalsky commented Mar 23, 2023

Before submitting checklist

  • Did you update the CHANGELOG? (not for test updates, internal changes/refactors or CI/CD setup)
  • Did you asked the docs owner to review all the updated user-facing interfaces?

@codecov
Copy link

codecov bot commented Mar 23, 2023

Codecov Report

Patch coverage: 50.00% and project coverage change: +0.92 🎉

Comparison is base (12d9e80) 71.35% compared to head (3278c77) 72.27%.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1309      +/-   ##
==========================================
+ Coverage   71.35%   72.27%   +0.92%     
==========================================
  Files         279      279              
  Lines       13634    13313     -321     
==========================================
- Hits         9728     9622     -106     
+ Misses       3906     3691     -215     
Flag Coverage Δ
e2e ?
py3.7 72.97% <50.00%> (?)
ubuntu 72.97% <50.00%> (?)
unit 72.97% <50.00%> (+72.97%) ⬆️
unit-pull-request 0.00% <0.00%> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
.../neptune/metadata_containers/metadata_container.py 89.95% <0.00%> (+1.77%) ⬆️
src/neptune/metadata_containers/model.py 93.65% <ø> (ø)
src/neptune/metadata_containers/project.py 94.23% <ø> (+2.92%) ⬆️
src/neptune/metadata_containers/run.py 91.86% <ø> (+1.43%) ⬆️
src/neptune/metadata_containers/model_version.py 95.52% <100.00%> (+4.47%) ⬆️

... and 162 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Raalsky Raalsky changed the title Draft: Docstrings in NeptuneObjects Docstrings in NeptuneObjects Mar 23, 2023
@Raalsky Raalsky changed the title Docstrings in NeptuneObjects Neptune objects and universal methods covered with docstrings Mar 23, 2023
@Raalsky Raalsky requested a review from normandy7 March 23, 2023 12:22
@@ -193,10 +193,51 @@ def __delitem__(self, path) -> None:

@ensure_not_stopped
def assign(self, value, *, wait: bool = False) -> None:
"""Assign values to multiple fields from a dictionary.
You can use this method to quickly log all run's parameters.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@normandy7 these are docstrings copied from Run but now all Neptune objects (Model, ModelVersion & Project) will inherit the same docstrings for all universal methods https://docs.neptune.ai/api/universal/ . We should probably tweak it to cover something much more "general" and change current Run-specific wording or add examples for all objects.

@Raalsky Raalsky merged commit cdc62d0 into master Apr 4, 2023
@Raalsky Raalsky deleted the rj/containers-docstrings branch April 4, 2023 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants