Skip to content

Create proper README #32

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.

Sign up for GitHub

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

Merged
merged 7 commits into from
Sep 3, 2024
Merged

Create proper README #32

Changes from 2 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
d8c6644
update README
normandy7 Sep 3, 2024
6d5623f
fix package name
normandy7 Sep 3, 2024
29689ce
fix configuration procedure
normandy7 Sep 3, 2024
60e6b76
review comments
normandy7 Sep 3, 2024
16dbcb9
experiment name length
normandy7 Sep 3, 2024
858fa49
Apply suggestions from code review
normandy7 Sep 3, 2024
939defe
Update README.md
normandy7 Sep 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
376 changes: 373 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,373 @@
### Local Environment
Create new virtual environment and run `pip install -r dev_requirements.txt`
Run `pre-commit install` to initialize [pre-commit](https://pre-commit.com/)
# Neptune Scale client

> [!NOTE]
> This package only works with the `3.0` version of neptune.ai called Neptune Scale, which is in beta.
>
> It's supported on Linux and MacOS.
>
> You can't use the Scale client with the stable Neptune `2.x` versions currently available to SaaS and self-hosting customers. For the Python client corresponding to Neptune `2.x`, see https://github.com/neptune-ai/neptune-client.

**What is Neptune?**

Neptune is an experiment tracker. It enables researchers to monitor their model training, visualize and compare model metadata, and collaborate on AI/ML projects within a team.

**What's different about Neptune Scale?**

Neptune Scale is the next major version of Neptune. It's built on an entirely new architecture for ingesting and rendering data, with a focus on responsiveness and accuracy at scale.

Neptune Scale supports forked experiments, with built-in mechanics for retaining run ancestry. This way, you can focus on analyzing the latest runs, but also visualize the full history of your experiments.

## Installation

```bash
pip install neptune-scale
```

### Configure API token and project

Log in to your Neptune Scale workspace. Get your API token from your user menu.

> If you're a workspace admin, you can also set up a service account. This way, multiple people or machines can share the same API token.

Install the neptune-scale package:

```
pip install neptune-scale
```

In the environment where neptune-scale is installed, set the following environment variables to the API token and project name obtained from the Neptune beta instance:

```
export NEPTUNE_API_TOKEN="h0dHBzOi8aHR0cHM.4kl0jvYh3Kb8...ifQ=="
```

```
export NEPTUNE_PROJECT="team-alpha/project-x"
```

You're ready to start using Neptune Scale.

## Example usage

```python
from neptune_scale import Run

run = Run(
family="RunFamilyName",
run_id="SomeUniqueRunIdentifier",
)

run.log_configs(
data={"learning_rate": 0.001, "batch_size": 64}
)

# inside a training loop
for e in epoch:
run.log_metrics(
data={"acc": 0.89, "loss": 0.17},
)

run.add_tags(tags=["tag1", "tag2"])

run.close()
```

## API reference

### `Run`

Representation of experiment tracking metadata logged with Neptune Scale.

#### Initialization

Initialize with the class constructor:

```python
from neptune_scale import Run

run = Run(...)
```

or using a context manager:

```python
from neptune_scale import Run

with Run(...) as run:
...
```

__Parameters__

| Name | Type | Default | Description |
|------------------|------------------|---------|---------------------------------------------------------------------------|
| `family` | `str` | - | Identifies related runs. All runs of the same lineage must have the same `family` value. That is, forking is only possible within the same family. Max length: 128 bytes. |
| `run_id` | `str` | - | Identifier of the run. Must be unique within the project. Max length: 128 bytes. |
| `project` | `str`, optional | `None` | Name of a project in the form `workspace-name/project-name`. If `None`, the value of the `NEPTUNE_PROJECT` environment variable is used. |
| `api_token` | `str`, optional | `None` | Your Neptune API token or a service account's API token. If `None`, the value of the `NEPTUNE_API_TOKEN` environment variable is used. To keep your token secure, don't place it in source code. Instead, save it as an environment variable. |
| `resume` | `bool`, optional | `False` | If `False` (default), creates a new run. To continue an existing run, set to `True` and pass the ID of an existing run to the `run_id` argument. To fork a run, use `fork_run_id` and `fork_step` instead. |
| `mode` | `Literal`, `"async"` or `"disabled"` | `"async"` | Mode of operation. If set to `"disabled"`, the run doesn't log any metadata. |
| `experiment_name` | `str`, optional | `None` | Name of the experiment to associate the run with. Learn more about [experiments](https://docs-beta.neptune.ai/experiments) in the Neptune documentation. |
| `creation_time` | `datetime`, optional | `None` | Custom creation time of the run. |
| `fork_run_id` | `str`, optional | `None` | If forking off an existing run, ID of the run to fork from. |
| `fork_step` | `int`, optional | `None` | If forking off an existing run, step number to fork from. |
| `max_queue_size` | `int`, optional | 1M | Maximum number of operations queued for processing. 1 000 000 by default. You should raise this value if you see the `on_queue_full_callback` function being called. |
| `on_queue_full_callback` | `Callable[[BaseException, Optional[float]], None]`, optional | `None` | Callback function triggered when the queue is full. The function must take as an argument the exception that made the queue full and, as an optional argument, a timestamp of when the exception was last raised. |
| `on_network_error_callback` | `Callable[[BaseException, Optional[float]], None]`, optional | `None` | Callback function triggered when a network error occurs. |
| `on_error_callback` | `Callable[[BaseException, Optional[float]], None]`, optional | `None` | The default callback function triggered when an unrecoverable error occurs. Applies if an error wasn't caught by other callbacks. In this callback you can choose to perform your cleanup operations and close the training script. For how to end the run in this case, use [`terminate()`](#terminate). |
| `on_warning_callback` | `Callable[[BaseException, Optional[float]], None]`, optional | `None` | Callback function triggered when a warning occurs. |

__Examples__

Create a new run:

```python
from neptune_scale import Run

with Run(
project="team-alpha/project-x",
api_token="h0dHBzOi8aHR0cHM6...Y2MifQ==",
family="aquarium",
run_id="likable-barracuda",
) as run:
...
```

> [!TIP]
> Find your API token in your user menu, in the bottom-left corner of the Neptune app.
>
> Or, to use shared API tokens for multiple users or non-human accounts, create a service account in your workspace settings.

Create a forked run and mark it as an experiment:

```python
with Run(
family="aquarium",
run_id="adventurous-barracuda",
experiment_name="swim-further",
fork_run_id="likable-barracuda",
fork_step=102,
) as run:
...
```

Continue a run:

```python
with Run(
family="aquarium",
run_id="likable-barracuda", # a Neptune run with this ID already exists
resume=True,
) as run:
...
```

### `close()`

The regular way to end a run. Waits for all locally queued data to be processed by Neptune (see [`wait_for_processing()`](#wait_for_processing)) and closes the run.

This is a blocking operation. Call the function at the end of your script, after your model training is completed.

__Examples__

```python
from neptune_scale import Run

run = Run(...)

# logging and training code

run.close()
```

If using a context manager, Neptune automatically closes the run upon exiting the context:

```python
with Run(...) as run:
...

# run is closed at the end of the context
```

### `log_configs()`

Logs the specified metadata to a Neptune run.

You can log configurations or other single values. Pass the metadata as a dictionary `{key: value}` with

- `key`: path to where the metadata should be stored in the run.
- `value`: the piece of metadata to log.

For example, `{"parameters/learning_rate": 0.001}`. In the field path, each forward slash `/` nests the field under a namespace. Use namespaces to structure the metadata into meaningful categories.

__Parameters__

| Name | Type | Default | Description |
|---------------|----------------------------------------------------|---------|---------------------------------------------------------------------------|
| `timestamp` | `datetime`, optional | `None` | Time of logging the metadata. |
| `data` | `Dict[str, Union[float, bool, int, str, datetime, list, set]]`, optional | `None` | Dictionary of configs or other values to log. Available types: float, integer, Boolean, string, and datetime. |

__Examples__

Create a run and log metadata:

```python
from neptune_scale import Run

with Run(...) as run:
run.log_configs(
data={
"parameters/learning_rate": 0.001,
"parameters/batch_size": 64,
},
)
```

### `log_metrics()`

Logs the specified metrics to a Neptune run.

You can log metrics representing a series of float values. Pass the metadata as a dictionary `{key: value}` with

- `key`: path to where the metadata should be stored in the run.
- `value`: the piece of metadata to log.

For example, `{"metrics/accuracy": 0.89}`. In the field path, each forward slash `/` nests the field under a namespace. Use namespaces to structure the metadata into meaningful categories.

__Parameters__

| Name | Type | Default | Description |
|---------------|----------------------------------------------------|---------|---------------------------------------------------------------------------|
| `step` | `Union[float, int]`, optional | `None` | Index of the log entry. Must be increasing. If not specified, the `log_metrics()` call increments the step starting from the highest already logged value. **Tip:** Using float rather than int values can be useful, for example, when logging substeps in a batch. |
| `timestamp` | `datetime`, optional | `None` | Time of logging the metadata. |
| `data` | `Dict[str, float]`, optional | `None` | Dictionary of metrics to log. Each metric value is associated with a step. To log multiple metrics at once, pass multiple key-value pairs. |

__Examples__

Create a run and log metrics:

```python
from neptune_scale import Run

with Run(...) as run:
run.log_metrics(
data={"loss": 0.14, "acc": 0.78},
)
```

**Note:** To correlate logged values, make sure to send all metadata related to a step in a single `log_metrics()` call, or specify the step explicitly.

When the run is forked off an existing one, the step can't be smaller than the step value of the fork point.

### `add_tags()`

Adds the list of tags to the run.

__Parameters__

| Name | Type | Default | Description |
|---------------|----------------------------------------------------|---------|---------------------------------------------------------------------------|
| `tags` | `Union[List[str], Set[str]]` | - | List or set of tags to add to the run. |
| `timestamp` | `datetime`, optional | `None` | Time of logging the metadata. |
| `group_tags` | `bool`, optional | `False` | Add group tags instead of regular tags. |

__Example__

```python
with Run(...) as run:
run.add_tags(tags=["tag1", "tag2", "tag3"])
```

### `remove_tags()`

Removes the specified tags from the run.

__Parameters__

| Name | Type | Default | Description |
|---------------|----------------------------------------------------|---------|---------------------------------------------------------------------------|
| `tags` | `Union[List[str], Set[str]]` | - | List or set of tags to remove from the run. |
| `timestamp` | `datetime`, optional | `None` | Time of logging. |
| `group_tags` | `bool`, optional | `False` | Remove group tags instead of regular tags. |

__Example__

```python
with Run(...) as run:
run.remove_tags(tags=["tag2", "tag3"])
```

### `wait_for_submission()`

Waits until all metadata is submitted to Neptune for processing.

When submitted, the data is not yet saved in Neptune (see [`wait_for_processing()`](#wait_for_processing)).

__Parameters__

| Name | Type | Default | Description |
|-----------|-------------------|---------|---------------------------------------------------------------------------|
| `timeout` | `float`, optional | `None` | In seconds, the maximum time to wait for submission. |
| `verbose` | `bool`, optional | `True` | If True (default), prints messages about the waiting process. |

__Example__

```python
from neptune_scale import Run

with Run(...) as run:
run.log_configs(...)
...
run.wait_for_submission()
run.log_metrics(...) # called once queued Neptune operations have been submitted
```

### `wait_for_processing()`

Waits until all metadata is processed by Neptune.

Once the call is complete, the data is saved in Neptune.

__Parameters__

| Name | Type | Default | Description |
|-----------|-------------------|---------|---------------------------------------------------------------------------|
| `timeout` | `float`, optional | `None` | In seconds, the maximum time to wait for processing. |
| `verbose` | `bool`, optional | `True` | If True (default), prints messages about the waiting process. |

__Example__

```python
from neptune_scale import Run

with Run(...) as run:
run.log_configs(...)
...
run.wait_for_processing()
run.log_metrics(...) # called once submitted data has been processed
```

### `terminate()`

In case an unrecoverable error is encountered, you can terminate the failed run in your error callback.

**Note:** This effectively disables processing in-flight operations as well as logging new data. However,
the training process isn't interrupted.

__Example__

```python
from neptune_scale import Run

def my_error_callback(exc):
run.terminate()


run = Run(..., on_error_callback=my_error_callback)
```

---

## Getting help

For help, contact support@neptune.ai.
Loading