Skip to content

Commit

Permalink
Update src/neptune_scale/__init__.py
Browse files Browse the repository at this point in the history
Co-authored-by: Edyta <[email protected]>
  • Loading branch information
Raalsky and szaganek authored Jul 26, 2024
1 parent 1a48ff2 commit 8fb0b0c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions src/neptune_scale/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ class Run(AbstractContextManager):
"""

def __init__(self, *, project: str, api_token: str, family: str, run_id: str) -> None:
"""
Initializes a run that logs the model-building metadata to Neptune.
Args:
project: Name of the project where the metadata is logged, in the form `workspace-name/project-name`.
api_token: Your Neptune API token.
family: Identifies related runs. For example, the same value must apply to all runs within a run hierarchy.
Max length: 128 characters.
run_id: Unique identifier of a run. Must be unique within the project. Max length: 128 characters.
"""
verify_type("api_token", api_token, str)
verify_type("family", family, str)
verify_type("run_id", run_id, str)
Expand Down

0 comments on commit 8fb0b0c

Please sign in to comment.