Latest Threat Research:SANDWORM_MODE: Shai-Hulud-Style npm Worm Hijacks CI Workflows and Poisons AI Toolchains.Details →
Socket
Book a DemoInstallSign in
Socket
Book a DemoInstallSign in

neptune

Package Overview
Dependencies
Maintainers
2
Versions
73
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

neptune - npm Package Compare versions

Comparing version
1.13.1rc1
 to
1.14.0
+3
-3
CHANGELOG.md

@@ -1,5 +0,5 @@

## neptune 1.13.1
## neptune 1.14.0
### Fixes
- Fix missing distutils dependency error that could appear when installing on Python 3.12+
### Features
- More descriptive warning message on hitting workspace logging-rate limits ([#1895](https://github.com/neptune-ai/neptune-client/pull/1895))

@@ -6,0 +6,0 @@ ## neptune 1.13.0

+13
-206
PKG-INFO
Metadata-Version: 2.3
Name: neptune
Version: 1.13.1rc1
Version: 1.14.0
Summary: Neptune Client

@@ -95,9 +95,7 @@ License: Apache-2.0

<div align="center">
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Github-cover.png" width="1500" />
<h1>neptune.ai</h1>
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Github-cover-022025.png" width="1500" />
<h1>neptune.ai Legacy</h1>
</div>
<div align="center">
<a href="https://docs.neptune.ai/usage/quickstart/">Quickstart</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://neptune.ai/">Website</a>

@@ -107,6 +105,2 @@ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>

<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://github.com/neptune-ai/examples">Examples</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://neptune.ai/resources">Resource center</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://neptune.ai/blog">Blog</a>

@@ -117,208 +111,21 @@ &nbsp;

## What is neptune.ai?
> [!IMPORTANT]
> This is the legacy client.<br/>
> For the new Neptune client, go to **[neptune-client-scale &rarr;][client]**
Neptune is a lightweight experiment tracker for ML teams that struggle with debugging and reproducing experiments, sharing results, and messy model handover. <b>It offers a single place to track, compare, store, and collaborate on experiments and models.</b>
> [!NOTE]
> If you need to access Neptune Legacy (app version `2.x`), see the [legacy documentation][legacy-setup] for setup instructions.
<hr />
With Neptune, Data Scientists can develop production-ready models faster, and ML Engineers can access model artifacts instantly in order to deploy them to production.
&nbsp;
<a href="https://www.youtube.com/watch?v=bQzgnqM5J6U"><b>Watch a 3min explainer video →</b></a>
&nbsp;
<a href="https://neptune.ai/demo"><b>Watch a 20min product demo →</b></a>
&nbsp;
<a href="https://app.neptune.ai/o/showcase/org/onboarding-project/runs/table?viewId=98f66b32-2279-4b73-8210-863021c440ac&product_tour_id=444083"><b>Play with a live example project in the Neptune app →</b></a>
&nbsp;
## Getting started
**Step 1:** Create a **[free account](https://neptune.ai/register)**
**Step 2:** Install the Neptune client library
```bash
pip install neptune
```
**Step 3:** Add an experiment tracking snippet to your code
```python
import neptune
run = neptune.init_run(project="workspace-name/project-name")
run["parameters"] = {"lr": 0.1, "dropout": 0.4}
run["test_accuracy"] = 0.84
```
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neptune-ai/examples/blob/master/how-to-guides/hello-neptune/notebooks/hello_neptune.ipynb)
&nbsp;
&nbsp;
## Core features
**Log and display**
Add a snippet to any step of your ML pipeline once. Decide what and how you want to log. Run a million times.
* <a href="https://docs.neptune.ai/integrations/"><b>Any framework:</b></a> any code, fastai, PyTorch, Lightning, TensorFlow/Keras, scikit-learn, 🤗 Transformers, XGBoost, Optuna.
* <a href="https://docs.neptune.ai/logging/what_you_can_log/"><b>Any metadata type:</b></a> metrics, parameters, dataset and model versions, images, interactive plots, videos, hardware (GPU, CPU, memory), code state.
* <a href="https://docs.neptune.ai/usage/best_practices/"><b>From anywhere in your ML pipeline:</b></a> multinode pipelines, distributed computing, log during or after execution, log offline, and sync when you are back online.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="all metadata metrics" src="https://neptune.ai/wp-content/uploads/2023/06/log_metrics.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Organize experiments**
Organize logs in a fully customizable nested structure. Display model metadata in user-defined dashboard templates.
* <a href="https://docs.neptune.ai/about/namespaces_and_fields/"><b>Nested metadata structure:</b></a> the flexible API lets you customize the metadata logging structure however you want. Organize nested parameter configs or the results on k-fold validation splits the way they should be.
* <a href="https://docs.neptune.ai/app/custom_dashboard/"><b>Custom dashboards:</b></a> combine different metadata types in one view. Define it for one run. Use anywhere. Look at GPU, memory consumption, and load times to debug training speed. See learning curves, image predictions, and confusion matrix to debug model quality.
* <a href="https://docs.neptune.ai/app/custom_views/"><b>Table views:</b></a> create different views of the runs table and save them for later. You can have separate table views for debugging, comparing parameter sets, or best experiments.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="organize dashboards" src="https://neptune.ai/wp-content/uploads/2023/06/organize_custom_dashboards.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Compare results**
Visualize training live in the neptune.ai web app. See how different parameters and configs affect the results. Optimize models quicker.
* <a href="https://docs.neptune.ai/app/comparison/"><b>Compare:</b></a> learning curves, parameters, images, datasets.
* <a href="https://docs.neptune.ai/app/searching_table/"><b>Search, sort, and filter:</b></a> experiments by any field you logged. Use our query language to filter runs based on parameter values, metrics, execution times, or anything else.
* <a href="https://docs.neptune.ai/app/runs_table/"><b>Visualize and display:</b></a> runs table, interactive display, folder structure, dashboards.
* <a href="https://docs.neptune.ai/tutorials/monitoring_training_live/"><b>Monitor live:</b></a> hardware consumption metrics, GPU, CPU, memory.
* <a href="https://docs.neptune.ai/app/group_by/"><b>Group by:</b></a> dataset versions, parameters.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="compare, search, filter" src="https://neptune.ai/wp-content/uploads/2023/06/organize_search_sort_filter.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Version models**
Version, review, and access production-ready models and metadata associated with them in a single place.
* <a href="https://docs.neptune.ai/model_registry/registering_model/"><b>Version models:</b></a> register models, create model versions, version external model artifacts.
* <a href="https://docs.neptune.ai/model_registry/managing_stage/"><b>Review and change stages:</b></a> look at the validation, test metrics and other model metadata. You can move models between None/Staging/Production/Archived.
* <a href="https://docs.neptune.ai/model_registry/overview/"><b>Access and share models:</b></a> every model and model version is accessible via the neptune.ai web app or through the API.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="register models" src="https://neptune.ai/wp-content/uploads/2023/06/register_models.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Share results**
Have a single place where your team can see the results and access all models and experiments.
* <a href="https://docs.neptune.ai/about/collaboration/"><b>Send a link:</b></a> share every chart, dashboard, table view, or anything else you see in the neptune.ai app by copying and sending persistent URLs.
* <a href="https://docs.neptune.ai/usage/querying_metadata/"><b>Query API:</b></a> access all model metadata via neptune.ai API. Whatever you logged, you can query in a similar way.
* <a href="https://docs.neptune.ai/management/"><b>Manage users and projects:</b></a> create different projects, add users to them, and grant different permissions levels.
* <a href="https://neptune.ai/pricing"><b>Add your entire org:</b></a> you can collaborate with a team on every plan, even the Free one. So, invite your entire organization, including product managers and subject matter experts, to increase the visibility from the very beginning.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="share persistent link" src="https://neptune.ai/wp-content/uploads/2023/06/share_send_link.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
## Integrate with any MLOps stack
neptune.ai integrates with <a href="https://docs.neptune.ai/integrations/"><b>25+ frameworks:</b></a> PyTorch, Lightning, TensorFlow/Keras, LightGBM, scikit-learn, XGBoost, Optuna, Kedro, 🤗 Transformers, fastai, Prophet, detectron2, Airflow, and more.
#### <img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Pytorch-lightning-logo.png" width="60" /> <br> <br> PyTorch Lightning
Example:
```python
from pytorch_lightning import Trainer
from lightning.pytorch.loggers import NeptuneLogger
# Create NeptuneLogger instance
from neptune import ANONYMOUS_API_TOKEN
neptune_logger = NeptuneLogger(
api_key=ANONYMOUS_API_TOKEN,
project="common/pytorch-lightning-integration",
tags=["training", "resnet"], # optional
)
# Pass the logger to the Trainer
trainer = Trainer(max_epochs=10, logger=neptune_logger)
# Run the Trainer
trainer.fit(my_model, my_dataloader)
```
[![neptune-pl](https://img.shields.io/badge/PytorchLightning-experiment-success?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAgCAYAAABQISshAAAACXBIWXMAAA7DAAAOwwHHb6hkAAAF6klEQVRYCa2YXWiWZRjH301nGWVTa36ESWqb1bTSorSTUg8kwg4iSIhOgo49yDoIOomgjiqQPCroIEGQqA6ighoIZYbZNEtnhU1rUc3U5fzY3Nbv//hcT//33rN37zu74Nr1fV33fd1fz95KpQaMjo7OHBsb2wy+A74HbgXbaoTUZSLHevBj8A/wGLiNWjfVFdyokxJT4CMwhb0obm40X/iT9zHiB9KkyF3Yrg+//4WSdBq4s6RYqN6GaWq0GDGLwePgRLCl0Zw1/amyDhyaqBr6U2B7zSQlRmJeLcvJSoR6P8w1JaGNq0jUBO6IzDm9CB1OdFsbyU7sQvDXJMfZRL6EvKGRvOHbHIzRpfAbTT4L/zj4FHjB9I/SyRkmT8Y+jIMf6N3Ia8HtFjgNfpPJU2fpyJakS7siG/ous52DXxW2WhS/ZvB9ixX7pGJoxhL4k2Y7At/woa9aEZKqI+qcw2cm7DF+Jvw6kydkGdgCjPebwwD815Kbmpp+CV4ysAxcnXEN/KmaCEl1rXqSIeRuy3cAfszkhxikJl8TyKuVu9GcjsD3SsY2CvlKfA7K92AI9dKqiRB0HzjHgvvgj4bMoA/BnwsZugrdPJMnYtdg8FoHmMBFc94PrwkFPFBPg8JZ1JNLVkGHHxBOhYLi6uLxkKFt6FaYPI7NB5SeJa1sAfiojrZbQCc6bce6oZgIgbqBfFspiTrnnRpEp6IBik9jwhZ0LsztIUAvgVrZAqjxG8LPhaJSuQG+ZoPMN2OLiSC1ge2Jw3cuU1Dnw8+MzKtHRkZqvfLKOV+OOZyEFttVOvLqWvfJNaNLV1GuE4JPZCles83zPHyPycFqIr5KnRSdFcYSuhJdi+k1iX6Tg00bpPNXq0ERl9F0ItPN+jv8MZODVedOhwBdxESWmJyydyWKQ/gPJzqJB8ER03fCX2dyFcskV4CvgM/xbMzxgS+u8ry8GmcSncS4yeJd0HtyB/itjA75yy+bQ9VBN4OuZK1U3IKL4G8Bx/kz+Dnod4CarLZmh6/IVVIapAc9MxGUvi3Sp10PX507PXABWgk/C6EX/RP0sxMNcp+MZyKq5w1a7xPZhfF4HnUC5505X0Z07zusxL/sYbwVJ3Uv4C/8fgzBKQ3Sbabt5VDaIBxuA/38/FNsLRLtYytsgN6N04Hm5uayg54VYTAH85WZkSkqlQ50s+G1NRzUtaIGfA9xf7uD8+Toxu4qnQPdYH65aCtlW8oce7xIhcGrW6UdsyAlko/ufu1hwXx0uvXSiejGctBBV+dLAZuu+4tgbPPlTKQVuZg8ssa8HHTY51vLDZPxp3HwN0Yr43u2QsFxOny6ayUmRg3qM58FeYNMlW3VZabQah2c0kRIruBvLJnYdD/rI9EL6tHzySumCnhY1aDDptTKVDUIWSuvSyRgAKZnShPJM2givnc7GYhv1XbsftBPINfcti0tLcqXXrd3onPQQddqB/Sykn1XMhHdMPrcCFjOSs0NAaoV8olpW50xeynLoNQg/1dBB95vxPSgf9/f33/+Siail9/fBH0J68YLuCcYUQbzJXYfoJsLHh9tP22XAH1wZv/LkENXWkcYcrq/ra1t3Gd84jOxSEHdPuk/RI8ogoLXQu4Vn4O+23aHMAntxe7nROchcrXC+4oMI/sYsuK+DbBPDrw7Gxn0CBign4meAV8LRU734nv15BkvexCjbygHvXGbULwpJXzYDsPPyqLQzANfB7vAlziwlw11VCVJKzGHQU8uMYUX60hXuJB3DQkuKEkMGpqNXiR0mN8oghDeVYDBy0ND+pyqD4h7wWLL2DMo0yu0ZnL8p4MfKpkNWqLL+q1tbZEIQdvBYQ/B/v9D4VvG4LuA4J+UIC2aJ902ODhY9d1RlifVkUv/t6c/4OUpM/IWf/+7rBA+ldoGsR2xocLEbiZGHfI84j8HsxsnHWg9MumeVUrlTeATZH8Usx/I2lF+ASrgAwovrKdI6kPsE2A3KOgD9TvvlCcR+cnxNKgf7QRHwec5x+N+wPsX+f7UoKzjPDEAAAAASUVORK5CYII=)](https://app.neptune.ai/common/pytorch-lightning-integration/experiments?split=tbl&dash=charts&viewId=faa75e77-5bd6-42b9-9379-863fe7a33227)
&nbsp;
[![github-code](https://img.shields.io/badge/GitHub-code-informational?logo=github)](https://github.com/neptune-ai/examples/tree/main/integrations-and-supported-tools/pytorch-lightning/scripts)
[![jupyter-code](https://img.shields.io/badge/Jupyter-code-informational?logo=jupyter)](https://github.com/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)
[<img src="https://img.shields.io/badge/docs-PyTorch%20Lightning-yellow">](https://docs.neptune.ai/integrations/lightning/)
&nbsp;
&nbsp;
## neptune.ai is trusted by great companies
<div align="center">
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/github-customers.png" width="1500" />
</div>
&nbsp;
Read how various customers use Neptune to <a href="https://neptune.ai/customers">improve their workflow</a>.
&nbsp;
&nbsp;
## Support
If you get stuck or simply want to talk to us about something, here are your options:
* Check our <a href="https://docs.neptune.ai/getting_help/#faq">FAQ page</a>.
* Take a look at our <a href="https://neptune.ai/resources">resource center</a>.
* Chat! In the app, click the <a href="https://docs.neptune.ai/getting_help/#chat">blue message icon</a> in the bottom-right corner and send a message. A real person will talk to you ASAP (typically very ASAP).
* You can just shoot us an email at [support@neptune.ai](mailto:support@neptune.ai).
* Chat! In the Legacy app, click the blue message icon in the bottom-right corner and send a message. A real person will talk to you ASAP (typically very ASAP).
* Shoot us an email at [support@neptune.ai](mailto:support@neptune.ai).
&nbsp;
&nbsp;
## People behind
Created with :heart: by the [neptune.ai team](https://neptune.ai/jobs#team)
[client]: https://github.com/neptune-ai/neptune-client-scale
[legacy-setup]: https://docs-legacy.neptune.ai/setup
+2
-2
pyproject.toml
[build-system]
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning", "setuptools>=42"]
requires = ["poetry-core>=1.0.0", "poetry-dynamic-versioning"]
build-backend = "poetry_dynamic_versioning.backend"

@@ -96,3 +96,3 @@

readme = "README.md"
version = "1.13.1-rc.1"
version = "1.14.0"
classifiers = [

@@ -99,0 +99,0 @@ "Development Status :: 5 - Production/Stable",

+12
-205
README.md
<div align="center">
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Github-cover.png" width="1500" />
<h1>neptune.ai</h1>
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Github-cover-022025.png" width="1500" />
<h1>neptune.ai Legacy</h1>
</div>
<div align="center">
<a href="https://docs.neptune.ai/usage/quickstart/">Quickstart</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://neptune.ai/">Website</a>

@@ -13,6 +11,2 @@ <span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>

<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://github.com/neptune-ai/examples">Examples</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://neptune.ai/resources">Resource center</a>
<span>&nbsp;&nbsp;•&nbsp;&nbsp;</span>
<a href="https://neptune.ai/blog">Blog</a>

@@ -23,207 +17,20 @@ &nbsp;

## What is neptune.ai?
> [!IMPORTANT]
> This is the legacy client.<br/>
> For the new Neptune client, go to **[neptune-client-scale &rarr;][client]**
Neptune is a lightweight experiment tracker for ML teams that struggle with debugging and reproducing experiments, sharing results, and messy model handover. <b>It offers a single place to track, compare, store, and collaborate on experiments and models.</b>
> [!NOTE]
> If you need to access Neptune Legacy (app version `2.x`), see the [legacy documentation][legacy-setup] for setup instructions.
<hr />
With Neptune, Data Scientists can develop production-ready models faster, and ML Engineers can access model artifacts instantly in order to deploy them to production.
&nbsp;
<a href="https://www.youtube.com/watch?v=bQzgnqM5J6U"><b>Watch a 3min explainer video →</b></a>
&nbsp;
<a href="https://neptune.ai/demo"><b>Watch a 20min product demo →</b></a>
&nbsp;
<a href="https://app.neptune.ai/o/showcase/org/onboarding-project/runs/table?viewId=98f66b32-2279-4b73-8210-863021c440ac&product_tour_id=444083"><b>Play with a live example project in the Neptune app →</b></a>
&nbsp;
## Getting started
**Step 1:** Create a **[free account](https://neptune.ai/register)**
**Step 2:** Install the Neptune client library
```bash
pip install neptune
```
**Step 3:** Add an experiment tracking snippet to your code
```python
import neptune
run = neptune.init_run(project="workspace-name/project-name")
run["parameters"] = {"lr": 0.1, "dropout": 0.4}
run["test_accuracy"] = 0.84
```
[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neptune-ai/examples/blob/master/how-to-guides/hello-neptune/notebooks/hello_neptune.ipynb)
&nbsp;
&nbsp;
## Core features
**Log and display**
Add a snippet to any step of your ML pipeline once. Decide what and how you want to log. Run a million times.
* <a href="https://docs.neptune.ai/integrations/"><b>Any framework:</b></a> any code, fastai, PyTorch, Lightning, TensorFlow/Keras, scikit-learn, 🤗 Transformers, XGBoost, Optuna.
* <a href="https://docs.neptune.ai/logging/what_you_can_log/"><b>Any metadata type:</b></a> metrics, parameters, dataset and model versions, images, interactive plots, videos, hardware (GPU, CPU, memory), code state.
* <a href="https://docs.neptune.ai/usage/best_practices/"><b>From anywhere in your ML pipeline:</b></a> multinode pipelines, distributed computing, log during or after execution, log offline, and sync when you are back online.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="all metadata metrics" src="https://neptune.ai/wp-content/uploads/2023/06/log_metrics.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Organize experiments**
Organize logs in a fully customizable nested structure. Display model metadata in user-defined dashboard templates.
* <a href="https://docs.neptune.ai/about/namespaces_and_fields/"><b>Nested metadata structure:</b></a> the flexible API lets you customize the metadata logging structure however you want. Organize nested parameter configs or the results on k-fold validation splits the way they should be.
* <a href="https://docs.neptune.ai/app/custom_dashboard/"><b>Custom dashboards:</b></a> combine different metadata types in one view. Define it for one run. Use anywhere. Look at GPU, memory consumption, and load times to debug training speed. See learning curves, image predictions, and confusion matrix to debug model quality.
* <a href="https://docs.neptune.ai/app/custom_views/"><b>Table views:</b></a> create different views of the runs table and save them for later. You can have separate table views for debugging, comparing parameter sets, or best experiments.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="organize dashboards" src="https://neptune.ai/wp-content/uploads/2023/06/organize_custom_dashboards.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Compare results**
Visualize training live in the neptune.ai web app. See how different parameters and configs affect the results. Optimize models quicker.
* <a href="https://docs.neptune.ai/app/comparison/"><b>Compare:</b></a> learning curves, parameters, images, datasets.
* <a href="https://docs.neptune.ai/app/searching_table/"><b>Search, sort, and filter:</b></a> experiments by any field you logged. Use our query language to filter runs based on parameter values, metrics, execution times, or anything else.
* <a href="https://docs.neptune.ai/app/runs_table/"><b>Visualize and display:</b></a> runs table, interactive display, folder structure, dashboards.
* <a href="https://docs.neptune.ai/tutorials/monitoring_training_live/"><b>Monitor live:</b></a> hardware consumption metrics, GPU, CPU, memory.
* <a href="https://docs.neptune.ai/app/group_by/"><b>Group by:</b></a> dataset versions, parameters.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="compare, search, filter" src="https://neptune.ai/wp-content/uploads/2023/06/organize_search_sort_filter.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Version models**
Version, review, and access production-ready models and metadata associated with them in a single place.
* <a href="https://docs.neptune.ai/model_registry/registering_model/"><b>Version models:</b></a> register models, create model versions, version external model artifacts.
* <a href="https://docs.neptune.ai/model_registry/managing_stage/"><b>Review and change stages:</b></a> look at the validation, test metrics and other model metadata. You can move models between None/Staging/Production/Archived.
* <a href="https://docs.neptune.ai/model_registry/overview/"><b>Access and share models:</b></a> every model and model version is accessible via the neptune.ai web app or through the API.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="register models" src="https://neptune.ai/wp-content/uploads/2023/06/register_models.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
**Share results**
Have a single place where your team can see the results and access all models and experiments.
* <a href="https://docs.neptune.ai/about/collaboration/"><b>Send a link:</b></a> share every chart, dashboard, table view, or anything else you see in the neptune.ai app by copying and sending persistent URLs.
* <a href="https://docs.neptune.ai/usage/querying_metadata/"><b>Query API:</b></a> access all model metadata via neptune.ai API. Whatever you logged, you can query in a similar way.
* <a href="https://docs.neptune.ai/management/"><b>Manage users and projects:</b></a> create different projects, add users to them, and grant different permissions levels.
* <a href="https://neptune.ai/pricing"><b>Add your entire org:</b></a> you can collaborate with a team on every plan, even the Free one. So, invite your entire organization, including product managers and subject matter experts, to increase the visibility from the very beginning.
&nbsp;
&nbsp;
<div align="center">
<img border="0" alt="share persistent link" src="https://neptune.ai/wp-content/uploads/2023/06/share_send_link.gif" width="600">
</a>
</div>
&nbsp;
&nbsp;
## Integrate with any MLOps stack
neptune.ai integrates with <a href="https://docs.neptune.ai/integrations/"><b>25+ frameworks:</b></a> PyTorch, Lightning, TensorFlow/Keras, LightGBM, scikit-learn, XGBoost, Optuna, Kedro, 🤗 Transformers, fastai, Prophet, detectron2, Airflow, and more.
#### <img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Pytorch-lightning-logo.png" width="60" /> <br> <br> PyTorch Lightning
Example:
```python
from pytorch_lightning import Trainer
from lightning.pytorch.loggers import NeptuneLogger
# Create NeptuneLogger instance
from neptune import ANONYMOUS_API_TOKEN
neptune_logger = NeptuneLogger(
api_key=ANONYMOUS_API_TOKEN,
project="common/pytorch-lightning-integration",
tags=["training", "resnet"], # optional
)
# Pass the logger to the Trainer
trainer = Trainer(max_epochs=10, logger=neptune_logger)
# Run the Trainer
trainer.fit(my_model, my_dataloader)
```
[![neptune-pl](https://img.shields.io/badge/PytorchLightning-experiment-success?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAgCAYAAABQISshAAAACXBIWXMAAA7DAAAOwwHHb6hkAAAF6klEQVRYCa2YXWiWZRjH301nGWVTa36ESWqb1bTSorSTUg8kwg4iSIhOgo49yDoIOomgjiqQPCroIEGQqA6ighoIZYbZNEtnhU1rUc3U5fzY3Nbv//hcT//33rN37zu74Nr1fV33fd1fz95KpQaMjo7OHBsb2wy+A74HbgXbaoTUZSLHevBj8A/wGLiNWjfVFdyokxJT4CMwhb0obm40X/iT9zHiB9KkyF3Yrg+//4WSdBq4s6RYqN6GaWq0GDGLwePgRLCl0Zw1/amyDhyaqBr6U2B7zSQlRmJeLcvJSoR6P8w1JaGNq0jUBO6IzDm9CB1OdFsbyU7sQvDXJMfZRL6EvKGRvOHbHIzRpfAbTT4L/zj4FHjB9I/SyRkmT8Y+jIMf6N3Ia8HtFjgNfpPJU2fpyJakS7siG/ous52DXxW2WhS/ZvB9ixX7pGJoxhL4k2Y7At/woa9aEZKqI+qcw2cm7DF+Jvw6kydkGdgCjPebwwD815Kbmpp+CV4ysAxcnXEN/KmaCEl1rXqSIeRuy3cAfszkhxikJl8TyKuVu9GcjsD3SsY2CvlKfA7K92AI9dKqiRB0HzjHgvvgj4bMoA/BnwsZugrdPJMnYtdg8FoHmMBFc94PrwkFPFBPg8JZ1JNLVkGHHxBOhYLi6uLxkKFt6FaYPI7NB5SeJa1sAfiojrZbQCc6bce6oZgIgbqBfFspiTrnnRpEp6IBik9jwhZ0LsztIUAvgVrZAqjxG8LPhaJSuQG+ZoPMN2OLiSC1ge2Jw3cuU1Dnw8+MzKtHRkZqvfLKOV+OOZyEFttVOvLqWvfJNaNLV1GuE4JPZCles83zPHyPycFqIr5KnRSdFcYSuhJdi+k1iX6Tg00bpPNXq0ERl9F0ItPN+jv8MZODVedOhwBdxESWmJyydyWKQ/gPJzqJB8ER03fCX2dyFcskV4CvgM/xbMzxgS+u8ry8GmcSncS4yeJd0HtyB/itjA75yy+bQ9VBN4OuZK1U3IKL4G8Bx/kz+Dnod4CarLZmh6/IVVIapAc9MxGUvi3Sp10PX507PXABWgk/C6EX/RP0sxMNcp+MZyKq5w1a7xPZhfF4HnUC5505X0Z07zusxL/sYbwVJ3Uv4C/8fgzBKQ3Sbabt5VDaIBxuA/38/FNsLRLtYytsgN6N04Hm5uayg54VYTAH85WZkSkqlQ50s+G1NRzUtaIGfA9xf7uD8+Toxu4qnQPdYH65aCtlW8oce7xIhcGrW6UdsyAlko/ufu1hwXx0uvXSiejGctBBV+dLAZuu+4tgbPPlTKQVuZg8ssa8HHTY51vLDZPxp3HwN0Yr43u2QsFxOny6ayUmRg3qM58FeYNMlW3VZabQah2c0kRIruBvLJnYdD/rI9EL6tHzySumCnhY1aDDptTKVDUIWSuvSyRgAKZnShPJM2givnc7GYhv1XbsftBPINfcti0tLcqXXrd3onPQQddqB/Sykn1XMhHdMPrcCFjOSs0NAaoV8olpW50xeynLoNQg/1dBB95vxPSgf9/f33/+Siail9/fBH0J68YLuCcYUQbzJXYfoJsLHh9tP22XAH1wZv/LkENXWkcYcrq/ra1t3Gd84jOxSEHdPuk/RI8ogoLXQu4Vn4O+23aHMAntxe7nROchcrXC+4oMI/sYsuK+DbBPDrw7Gxn0CBign4meAV8LRU734nv15BkvexCjbygHvXGbULwpJXzYDsPPyqLQzANfB7vAlziwlw11VCVJKzGHQU8uMYUX60hXuJB3DQkuKEkMGpqNXiR0mN8oghDeVYDBy0ND+pyqD4h7wWLL2DMo0yu0ZnL8p4MfKpkNWqLL+q1tbZEIQdvBYQ/B/v9D4VvG4LuA4J+UIC2aJ902ODhY9d1RlifVkUv/t6c/4OUpM/IWf/+7rBA+ldoGsR2xocLEbiZGHfI84j8HsxsnHWg9MumeVUrlTeATZH8Usx/I2lF+ASrgAwovrKdI6kPsE2A3KOgD9TvvlCcR+cnxNKgf7QRHwec5x+N+wPsX+f7UoKzjPDEAAAAASUVORK5CYII=)](https://app.neptune.ai/common/pytorch-lightning-integration/experiments?split=tbl&dash=charts&viewId=faa75e77-5bd6-42b9-9379-863fe7a33227)
&nbsp;
[![github-code](https://img.shields.io/badge/GitHub-code-informational?logo=github)](https://github.com/neptune-ai/examples/tree/main/integrations-and-supported-tools/pytorch-lightning/scripts)
[![jupyter-code](https://img.shields.io/badge/Jupyter-code-informational?logo=jupyter)](https://github.com/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)
[<img src="https://img.shields.io/badge/docs-PyTorch%20Lightning-yellow">](https://docs.neptune.ai/integrations/lightning/)
&nbsp;
&nbsp;
## neptune.ai is trusted by great companies
<div align="center">
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/github-customers.png" width="1500" />
</div>
&nbsp;
Read how various customers use Neptune to <a href="https://neptune.ai/customers">improve their workflow</a>.
&nbsp;
&nbsp;
## Support
If you get stuck or simply want to talk to us about something, here are your options:
* Check our <a href="https://docs.neptune.ai/getting_help/#faq">FAQ page</a>.
* Take a look at our <a href="https://neptune.ai/resources">resource center</a>.
* Chat! In the app, click the <a href="https://docs.neptune.ai/getting_help/#chat">blue message icon</a> in the bottom-right corner and send a message. A real person will talk to you ASAP (typically very ASAP).
* You can just shoot us an email at [support@neptune.ai](mailto:support@neptune.ai).
* Chat! In the Legacy app, click the blue message icon in the bottom-right corner and send a message. A real person will talk to you ASAP (typically very ASAP).
* Shoot us an email at [support@neptune.ai](mailto:support@neptune.ai).
&nbsp;
&nbsp;
## People behind
Created with :heart: by the [neptune.ai team](https://neptune.ai/jobs#team)
[client]: https://github.com/neptune-ai/neptune-client-scale
[legacy-setup]: https://docs-legacy.neptune.ai/setup
+1
-1
src/neptune/__init__.py

@@ -89,3 +89,3 @@ #

Learn more in the docs: https://docs.neptune.ai/api/neptune/
Learn more in the docs: https://docs-legacy.neptune.ai/api/neptune/
"""

@@ -92,0 +92,0 @@ __all__ = [

+79
-16
src/neptune/cli/containers.py

@@ -22,3 +22,2 @@ #

]
import os

@@ -44,2 +43,6 @@ import shutil

from neptune.common.exceptions import NeptuneConnectionLostException
from neptune.common.warnings import (
NeptuneWarning,
warn_once,
)
from neptune.constants import ASYNC_DIRECTORY

@@ -72,3 +75,9 @@ from neptune.core.components.operation_storage import OperationStorage

class ExecutionDirectory:
def __init__(self, path: Path, synced: bool, structure_version: StructureVersion, parent: Optional[Path] = None):
def __init__(
self,
path: Path,
synced: bool,
structure_version: StructureVersion,
parent: Optional[Path] = None,
):
self._path = path

@@ -99,3 +108,9 @@ self._synced = synced

def sync(self, *, backend: "NeptuneBackend", container_id: UniqueId, container_type: ContainerType) -> None:
def sync(
self,
*,
backend: "NeptuneBackend",
container_id: UniqueId,
container_type: ContainerType,
) -> None:
operation_storage = OperationStorage(self.path)

@@ -138,10 +153,28 @@ serializer: Callable[[Operation], Dict[str, Any]] = lambda op: op.to_dict()

raise ex
logger.warning(
"Experiencing connection interruptions."
" Will try to reestablish communication with Neptune."
" Internal exception was: %s",
ex.cause.__class__.__name__,
)
elif ex.cause.__class__.__name__ == "HTTPTooManyRequests":
warn_once(
"You're hitting the logging-rate limit for your workspace."
" Logging will be throttled to stay within limits."
" You might observe a delay in updates in the Neptune web app."
" NOTE: Your script is still running!"
" See how to optimize the logging calls to reduce requests: "
"https://docs.neptune.ai/help/reducing_requests/."
" To increase the limit for your workspace, contact sales@neptune.ai.",
exception=NeptuneWarning,
)
else:
logger.warning(
"Experiencing connection interruptions."
" Will try to reestablish communication with Neptune."
" Internal exception was: %s",
ex.cause.__class__.__name__,
)
def move(self, *, base_path: Path, target_container_id: UniqueId, container_type: ContainerType) -> None:
def move(
self,
*,
base_path: Path,
target_container_id: UniqueId,
container_type: ContainerType,
) -> None:
new_online_dir = get_container_dir(container_id=target_container_id, container_type=container_type)

@@ -173,3 +206,9 @@ try:

@abstractmethod
def sync(self, *, base_path: Path, backend: "NeptuneBackend", project: Optional["Project"] = None) -> None: ...
def sync(
self,
*,
base_path: Path,
backend: "NeptuneBackend",
project: Optional["Project"] = None,
) -> None: ...

@@ -221,3 +260,9 @@ def clear(self) -> None:

def sync(self, *, base_path: Path, backend: "NeptuneBackend", project: Optional["Project"] = None) -> None:
def sync(
self,
*,
base_path: Path,
backend: "NeptuneBackend",
project: Optional["Project"] = None,
) -> None:
assert self.experiment is not None # mypy fix

@@ -237,3 +282,7 @@

self.clear()
logger.info("Synchronization of %s %s completed.", self.experiment.type.value, qualified_container_name)
logger.info(
"Synchronization of %s %s completed.",
self.experiment.type.value,
qualified_container_name,
)

@@ -270,3 +319,9 @@

def sync(self, *, base_path: Path, backend: "NeptuneBackend", project: Optional["Project"] = None) -> None:
def sync(
self,
*,
base_path: Path,
backend: "NeptuneBackend",
project: Optional["Project"] = None,
) -> None:
assert project is not None # mypy fix

@@ -293,3 +348,7 @@

qualified_container_name = get_qualified_name(experiment)
logger.info("Offline container %s registered as %s", self.container_id, qualified_container_name)
logger.info(
"Offline container %s registered as %s",
self.container_id,
qualified_container_name,
)
logger.info("Synchronising %s", qualified_container_name)

@@ -305,3 +364,7 @@

self.clear()
logger.info("Synchronization of %s %s completed.", experiment.type.value, qualified_container_name)
logger.info(
"Synchronization of %s %s completed.",
experiment.type.value,
qualified_container_name,
)

@@ -308,0 +371,0 @@ 

+14
-14
src/neptune/common/exceptions.py

@@ -117,5 +117,5 @@ #

You may also want to check the following docs page:
- https://docs.neptune.ai/setup/setting_api_token/
- https://docs-legacy.neptune.ai/setup/setting_api_token/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -141,3 +141,3 @@ super().__init__(message.format(env_api_token=API_TOKEN_ENV_NAME, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -162,3 +162,3 @@ super().__init__(message.format(msg=msg, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -191,3 +191,3 @@ super().__init__(message.format(status=status, response=response, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -216,3 +216,3 @@ super().__init__(message.format(**STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -241,3 +241,3 @@ message = msg if msg is not None else default_message

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -265,9 +265,9 @@ super().__init__(message.format(response=response, **STYLES))

You can find detailed instructions on the following doc pages:
- https://docs.neptune.ai/api/connection_modes/#offline-mode
- https://docs.neptune.ai/api/neptune_sync/
- https://docs-legacy.neptune.ai/api/connection_modes/#offline-mode
- https://docs-legacy.neptune.ai/api/neptune_sync/
You may also want to check the following docs page:
- https://docs.neptune.ai/api/connection_modes/#connectivity-issues
- https://docs-legacy.neptune.ai/api/connection_modes/#connectivity-issues
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -320,6 +320,6 @@ super().__init__(message.format(**STYLES))

You may also want to check the following docs page:
- https://docs.neptune.ai/api/environment_variables/#neptune_allow_self_signed_certificate
- https://docs-legacy.neptune.ai/api/environment_variables/#neptune_allow_self_signed_certificate
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -432,4 +432,4 @@ super().__init__(message.format(**STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/help/error_writing_to_archived_project/
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/help/error_writing_to_archived_project/
"""
super(WritingToArchivedProjectException, self).__init__(message.format(**STYLES))
+1
-1
src/neptune/common/hardware/gpu/gpu_monitor.py

@@ -85,3 +85,3 @@ #

f"Info (NVML): {e}. GPU usage metrics may not be reported. For more information, "
"see https://docs.neptune.ai/help/nvml_error/"
"see https://docs-legacy.neptune.ai/help/nvml_error/"
)

@@ -88,0 +88,0 @@ warn_once(message=warning, exception=NeptuneWarning)

+1
-1
src/neptune/common/warnings.py

@@ -106,4 +106,4 @@ #

for dictionaries or collections that contain unsupported values.
For more, see https://docs.neptune.ai/help/value_of_unsupported_type""",
For more, see https://docs-legacy.neptune.ai/help/value_of_unsupported_type""",
exception=NeptuneUnsupportedType,
)
+70
-70
src/neptune/exceptions.py

@@ -156,3 +156,3 @@ #

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -175,3 +175,3 @@ self._msg = message.format(field_path=field_path, **STYLES)

{correct}Need help?{end}-> https://docs.neptune.ai/help/error_type_does_not_support_attribute/
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/help/error_type_does_not_support_attribute/
"""

@@ -332,5 +332,5 @@ self._msg = message.format(type=type_, attribute=attribute, **STYLES)

You may want to check the following docs page:
- https://docs.neptune.ai/setup/creating_project/
- https://docs-legacy.neptune.ai/setup/creating_project/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -354,5 +354,5 @@ super().__init__(

You may also want to check the following docs pages:
- https://docs.neptune.ai/setup/creating_project/
- https://docs-legacy.neptune.ai/setup/creating_project/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -397,5 +397,5 @@ super().__init__(message=message, available_projects=available_projects, project=project_id)

You may also want to check the following docs pages:
- https://docs.neptune.ai/setup/creating_project/
- https://docs-legacy.neptune.ai/setup/creating_project/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -423,6 +423,6 @@ super().__init__(

You may also want to check the following docs pages:
- https://docs.neptune.ai/logging/to_existing_object/
- https://docs.neptune.ai/usage/querying_metadata/
- https://docs-legacy.neptune.ai/logging/to_existing_object/
- https://docs-legacy.neptune.ai/usage/querying_metadata/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -443,6 +443,6 @@ super().__init__(

- Resume the run to continue logging to it:
https://docs.neptune.ai/logging/to_existing_object/
https://docs-legacy.neptune.ai/logging/to_existing_object/
- Don't invoke `stop()` on a run that you want to access. If you want to stop monitoring only,
you can resume a run in read-only mode:
https://docs.neptune.ai/api/connection_modes/#read-only-mode"""
https://docs-legacy.neptune.ai/api/connection_modes/#read-only-mode"""

@@ -456,6 +456,6 @@ def __init__(self, label: str):

- Resume the model to continue logging to it:
https://docs.neptune.ai/api/neptune/#init_model
https://docs-legacy.neptune.ai/api/neptune/#init_model
- Don't invoke `stop()` on a model that you want to access. If you want to stop monitoring only,
you can resume a model in read-only mode:
https://docs.neptune.ai/api/connection_modes/#read-only-mode"""
https://docs-legacy.neptune.ai/api/connection_modes/#read-only-mode"""

@@ -469,6 +469,6 @@ def __init__(self, label: str):

- Resume the model version to continue logging to it:
https://docs.neptune.ai/api/neptune/#init_model_version
https://docs-legacy.neptune.ai/api/neptune/#init_model_version
- Don't invoke `stop()` on a model version that you want to access. If you want to stop monitoring only,
you can resume a model version in read-only mode:
https://docs.neptune.ai/api/connection_modes/#read-only-mode"""
https://docs-legacy.neptune.ai/api/connection_modes/#read-only-mode"""

@@ -482,3 +482,3 @@ def __init__(self, label: str):

- Resume the connection to the project to continue logging to it:
https://docs.neptune.ai/api/neptune/#init_project
https://docs-legacy.neptune.ai/api/neptune/#init_project
- Don't invoke `stop()` on a project that you want to access."""

@@ -524,5 +524,5 @@

You may also want to check the following docs pages:
- https://docs.neptune.ai/setup/setting_api_token/
- https://docs-legacy.neptune.ai/setup/setting_api_token/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -552,6 +552,6 @@ super().__init__(message.format(env_api_token=API_TOKEN_ENV_NAME, **STYLES))

You may also want to check the following docs pages:
- https://docs.neptune.ai/usage/resume_run/
- https://docs.neptune.ai/api/connection_modes/#read-only-mode
- https://docs-legacy.neptune.ai/usage/resume_run/
- https://docs-legacy.neptune.ai/api/connection_modes/#read-only-mode
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -600,5 +600,5 @@ self.container_type = container_type

You may also want to check the following docs page:
- https://docs.neptune.ai/api/universal/#initialization-methods
- https://docs-legacy.neptune.ai/api/universal/#initialization-methods
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -632,6 +632,6 @@ super().__init__(

You may also want to check the following docs page:
- https://docs.neptune.ai/logging/to_existing_object/
- https://docs.neptune.ai/logging/custom_run_id/
- https://docs-legacy.neptune.ai/logging/to_existing_object/
- https://docs-legacy.neptune.ai/logging/custom_run_id/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -662,3 +662,3 @@ super().__init__(message.format(custom_id_env=CUSTOM_RUN_ID_ENV_NAME, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -686,5 +686,5 @@ super().__init__(

If you want to create a new object using {python}{called_function}{end}, {python}{parameter_name}{end} is required:
https://docs.neptune.ai/api/neptune#{called_function}
https://docs-legacy.neptune.ai/api/neptune#{called_function}
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -712,7 +712,7 @@ super().__init__(

If so, you may want to use the {python}proxies{end} parameter of the {python}init_run(){end} function.
See https://docs.neptune.ai/api/universal/#proxies
See https://docs-legacy.neptune.ai/api/universal/#proxies
and https://requests.readthedocs.io/en/latest/user/advanced/#proxies
- Check the status of Neptune services: https://status.neptune.ai/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -739,5 +739,5 @@ super().__init__(message.format(host=host, **STYLES))

You may also want to check the following docs page:
- https://docs.neptune.ai/api/connection_modes
- https://docs-legacy.neptune.ai/api/connection_modes
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -769,3 +769,3 @@ super().__init__(message.format(**STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -808,3 +808,3 @@ self._path = path

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -827,5 +827,5 @@ super().__init__(message.format(project=project, **STYLES))

For detailed instructions, check the integration guides:
- https://docs.neptune.ai/integrations
- https://docs-legacy.neptune.ai/integrations
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -859,5 +859,5 @@ framework_name = framework_name if framework_name else package_name

Learn more in the docs:
- https://docs.neptune.ai/help/error_limit_exceeded/
- https://docs.neptune.ai/help/workspace_or_project_read_only/
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
- https://docs-legacy.neptune.ai/help/error_limit_exceeded/
- https://docs-legacy.neptune.ai/help/workspace_or_project_read_only/
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -889,3 +889,3 @@ super().__init__(message.format(**STYLES, reason=reason))

For more details, see https://docs.neptune.ai/usage/best_practices
For more details, see https://docs-legacy.neptune.ai/usage/best_practices
""" # noqa: E501

@@ -916,4 +916,4 @@ super().__init__(

You may also want to check the following docs page:
- https://docs.neptune.ai/api/connection_modes
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
- https://docs-legacy.neptune.ai/api/connection_modes
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -941,5 +941,5 @@ super().__init__(message.format(**STYLES))

You may also want to check the following docs page:
- https://docs.neptune.ai/api/connection_modes
- https://docs-legacy.neptune.ai/api/connection_modes
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help.html
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help.html
"""

@@ -967,5 +967,5 @@ super().__init__(message.format(attribute_path=attribute_path, **STYLES))

You may also want to check the following docs page:
- https://docs.neptune.ai/api/connection_modes
- https://docs-legacy.neptune.ai/api/connection_modes
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help.html
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help.html
"""

@@ -999,3 +999,3 @@ super().__init__(message.format(artifact_hash=artifact_hash, **STYLES))

If you want to update your code with the new API, we prepared a handy migration guide:
- https://docs.neptune.ai/about/legacy/#migrating-to-neptunenew
- https://docs-legacy.neptune.ai/about/legacy/#migrating-to-neptunenew

@@ -1008,3 +1008,3 @@ You can read more about neptune.new in the release blog post:

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1024,7 +1024,7 @@ super().__init__(message.format(**STYLES))

- Updating your code to the new Python API requires few changes, but to help you with this process we prepared a handy migration guide:
https://docs.neptune.ai/about/legacy/#migrating-to-neptunenew
https://docs-legacy.neptune.ai/about/legacy/#migrating-to-neptunenew
- You can read more about neptune.new in the release blog post:
https://neptune.ai/blog/neptune-new
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
""" # noqa: E501

@@ -1044,3 +1044,3 @@ super().__init__(message.format(**STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1058,3 +1058,3 @@ super().__init__(message.format(scheme=scheme, path=path, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1072,3 +1072,3 @@ super().__init__(message.format(type_str=type_str, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1086,3 +1086,3 @@ super().__init__(message.format(path=path, expected_description=expected_description, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1100,3 +1100,3 @@ super().__init__(message.format(**STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1121,3 +1121,3 @@ super().__init__(message.format(location=location, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1135,3 +1135,3 @@ super().__init__(message.format(functionality_info=functionality_info, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1153,3 +1153,3 @@ super().__init__(message.format(location=location, namespace=namespace, **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1178,3 +1178,3 @@ self.message = message.format(missing_feature=missing_feature, **STYLES)

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1196,3 +1196,3 @@ super().__init__(message.format(model_key=model_key, models_tab_url=models_tab_url, **STYLES))

For details, see https://docs.neptune.ai/api/neptune_sync/
For details, see https://docs-legacy.neptune.ai/api/neptune_sync/

@@ -1203,3 +1203,3 @@ If the synchronization fails, you may want to check your connection and ensure that you're

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1218,5 +1218,5 @@ super().__init__(message.format(**STYLES))

For more, see https://docs.neptune.ai/api/field_types/#from_stream
For more, see https://docs-legacy.neptune.ai/api/field_types/#from_stream
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1249,5 +1249,5 @@ super().__init__(message.format(**STYLES))

You may also want to check the following docs page:
- https://docs.neptune.ai/api/connection_modes
- https://docs-legacy.neptune.ai/api/connection_modes
{correct}Need help?{end}-> https://docs.neptune.ai/getting_help/
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help/
"""

@@ -1265,3 +1265,3 @@ super().__init__(message.format(path=path_to_str([attribute, path]), **STYLES))

{correct}Need help?{end}-> https://docs.neptune.ai/getting_help
{correct}Need help?{end}-> https://docs-legacy.neptune.ai/getting_help
"""

@@ -1277,4 +1277,4 @@ super().__init__(

The provided NQL query is invalid: {nql_query}.
For syntax help, see https://docs.neptune.ai/usage/nql/
For syntax help, see https://docs-legacy.neptune.ai/usage/nql/
"""
super().__init__(message)
+23
-23
src/neptune/handler.py

@@ -171,3 +171,3 @@ #

For more information, see the docs:
https://docs.neptune.ai/api/field_types/#get_root_object
https://docs-legacy.neptune.ai/api/field_types/#get_root_object
"""

@@ -216,3 +216,3 @@ return self._container

For more information, see the docs:
https://docs.neptune.ai/api-reference/field-types
https://docs-legacy.neptune.ai/api-reference/field-types
"""

@@ -259,3 +259,3 @@ with self._container.lock():

For more information, see the docs:
https://docs.neptune.ai/api/field_types#upload
https://docs-legacy.neptune.ai/api/field_types#upload

@@ -318,3 +318,3 @@ """

For more information, see the docs:
https://docs.neptune.ai/api-reference/field-types
https://docs-legacy.neptune.ai/api-reference/field-types

@@ -380,3 +380,3 @@ """

When you log the first value, the type of the value determines what type of field is created.
To learn more about field types, see the docs: https://docs.neptune.ai/api/field_types
To learn more about field types, see the docs: https://docs-legacy.neptune.ai/api/field_types

@@ -389,3 +389,3 @@ Args:

wait: If True, the client sends all tracked metadata to the server before executing the call.
For more information, see: https://docs.neptune.ai/api/universal/#wait
For more information, see: https://docs-legacy.neptune.ai/api/universal/#wait

@@ -431,3 +431,3 @@ Examples:

When you log the first value, the type of the value determines what type of field is created.
To learn more about field types, see the docs: https://docs.neptune.ai/api/field_types
To learn more about field types, see the docs: https://docs-legacy.neptune.ai/api/field_types

@@ -440,3 +440,3 @@ Args:

wait: If True, the client sends all tracked metadata to the server before executing the call.
For details, see https://docs.neptune.ai/api/universal/#wait
For details, see https://docs-legacy.neptune.ai/api/universal/#wait

@@ -482,3 +482,3 @@ Example:

For more information, see the docs:
https://docs.neptune.ai/api/field_types#add
https://docs-legacy.neptune.ai/api/field_types#add
"""

@@ -507,3 +507,3 @@ verify_type("values", values, (str, Iterable))

See also the API reference: https://docs.neptune.ai/api/client_index/#pop
See also the API reference: https://docs-legacy.neptune.ai/api/client_index/#pop
"""

@@ -539,3 +539,3 @@ with self._container.lock():

For more information, see the docs:
https://docs.neptune.ai/api/field_types#remove
https://docs-legacy.neptune.ai/api/field_types#remove
"""

@@ -554,3 +554,3 @@ return self._pass_call_to_attr(function_name="remove", values=values, wait=wait)

For more information, see the docs:
https://docs.neptune.ai/api/field_types#clear
https://docs-legacy.neptune.ai/api/field_types#clear
"""

@@ -577,3 +577,3 @@ return self._pass_call_to_attr(function_name="clear", wait=wait)

For more information on field types, see the docs:
https://docs.neptune.ai/api-reference/field-types
https://docs-legacy.neptune.ai/api-reference/field-types
"""

@@ -594,3 +594,3 @@ return self._pass_call_to_attr(function_name="fetch")

For more information on field types, see the docs:
https://docs.neptune.ai/api-reference/field-types
https://docs-legacy.neptune.ai/api-reference/field-types
"""

@@ -625,3 +625,3 @@ return self._pass_call_to_attr(function_name="fetch_last")

For more information on field types, see the docs:
https://docs.neptune.ai/api-reference/field-types
https://docs-legacy.neptune.ai/api-reference/field-types
"""

@@ -648,3 +648,3 @@ return self._pass_call_to_attr(

For more information, see the docs:
https://docs.neptune.ai/api/field_types#delete_files
https://docs-legacy.neptune.ai/api/field_types#delete_files
"""

@@ -682,3 +682,3 @@ return self._pass_call_to_attr(function_name="delete_files", paths=paths, wait=wait)

For more information, see the docs:
https://docs.neptune.ai/api-reference/field-types
https://docs-legacy.neptune.ai/api-reference/field-types
"""

@@ -699,3 +699,3 @@ return self._pass_call_to_attr(function_name="download", destination=destination, progress_bar=progress_bar)

For more information, see the docs:
https://docs.neptune.ai/api/field_types#download_last
https://docs-legacy.neptune.ai/api/field_types#download_last
"""

@@ -708,3 +708,3 @@ return self._pass_call_to_attr(function_name="download_last", destination=destination)

You may also want to check the docs:
https://docs.neptune.ai/api/field_types#fetch_hash
https://docs-legacy.neptune.ai/api/field_types#fetch_hash
"""

@@ -717,3 +717,3 @@ return self._pass_call_to_attr(function_name="fetch_hash")

You may also want to check the docs:
https://docs.neptune.ai/api/field_types#fetch_extension
https://docs-legacy.neptune.ai/api/field_types#fetch_extension
"""

@@ -726,3 +726,3 @@ return self._pass_call_to_attr(function_name="fetch_extension")

You may also want to check the docs:
https://docs.neptune.ai/api/field_types#fetch_files_list
https://docs-legacy.neptune.ai/api/field_types#fetch_files_list
"""

@@ -764,3 +764,3 @@ return self._pass_call_to_attr(function_name="fetch_files_list")

For more information, see the API reference:
https://docs.neptune.ai/api/field_types#list_fileset_files
https://docs-legacy.neptune.ai/api/field_types#list_fileset_files
"""

@@ -777,3 +777,3 @@ return self._pass_call_to_attr(function_name="list_fileset_files", path=path)

You may also want to check the docs:
https://docs.neptune.ai/api/field_types#track_files
https://docs-legacy.neptune.ai/api/field_types#track_files
"""

@@ -780,0 +780,0 @@ with self._container.lock():

+1
-1
src/neptune/internal/backends/hosted_neptune_backend.py

@@ -1151,3 +1151,3 @@ #

f"Column {column} used for sorting is a complex type. For more, "
f"see https://docs.neptune.ai/api/field_types/#simple-types"
f"see https://docs-legacy.neptune.ai/api/field_types/#simple-types"
)

@@ -1154,0 +1154,0 @@ types.add(entry.type)

+23
-7
src/neptune/internal/threading/daemon.py

@@ -24,2 +24,6 @@ #

from neptune.common.exceptions import NeptuneConnectionLostException
from neptune.common.warnings import (
NeptuneWarning,
warn_once,
)
from neptune.internal.utils.logger import get_logger

@@ -82,3 +86,6 @@

with self._wait_condition:
return self._state in (Daemon.DaemonState.INTERRUPTED, Daemon.DaemonState.STOPPED)
return self._state in (
Daemon.DaemonState.INTERRUPTED,
Daemon.DaemonState.STOPPED,
)

@@ -130,8 +137,17 @@ def run(self):

if self_.last_backoff_time == 0:
logger.warning(
"Experiencing connection interruptions."
" Will try to reestablish communication with Neptune."
" Internal exception was: %s",
e.cause.__class__.__name__,
)
if e.cause.__class__.__name__ == "HTTPTooManyRequests":
warn_once(
"You're hitting the default logging-rate limit for your workspace."
" See how to optimize the logging calls to reduce requests:"
" https://docs.neptune.ai/help/reducing_requests/. \n"
" To increase the limits for your workspace, contact sales@neptune.ai.",
exception=NeptuneWarning,
)
else:
logger.warning(
"Experiencing connection interruptions."
" Will try to reestablish communication with Neptune."
" Internal exception was: %s",
e.cause.__class__.__name__,
)
self_.last_backoff_time = self.INITIAL_RETRY_BACKOFF

@@ -138,0 +154,0 @@ else:

+2
-2
src/neptune/internal/utils/deprecation.py

@@ -75,5 +75,5 @@ #

"Neptune's model registry has been deprecated and will be removed in a future release."
"Use runs to store model metadata instead. For more, see https://docs.neptune.ai/model_registry/."
"Use runs to store model metadata instead. For more, see https://docs-legacy.neptune.ai/model_registry/."
"If you are already using the model registry, you can migrate existing metadata to runs."
"Learn how: https://docs.neptune.ai/model_registry/migrate_to_runs/."
"Learn how: https://docs-legacy.neptune.ai/model_registry/migrate_to_runs/."
)

@@ -80,0 +80,0 @@ return func(*args, **kwargs)

+1
-1
src/neptune/management/__init__.py

@@ -106,3 +106,3 @@ #

See also the API reference in the docs: https://docs.neptune.ai/api/management
See also the API reference in the docs: https://docs-legacy.neptune.ai/api/management
"""

@@ -109,0 +109,0 @@ from .internal.api import (

+27
-19
src/neptune/management/internal/api.py

@@ -147,3 +147,3 @@ #

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -213,3 +213,3 @@ verify_type("api_token", api_token, (str, type(None)))

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -294,3 +294,3 @@ verify_type("name", name, str)

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -336,3 +336,3 @@ verify_type("project", project, str)

- "owner": Can view and edit project content and members.
For more information, see https://docs.neptune.ai/management/roles/
For more information, see https://docs-legacy.neptune.ai/management/roles/
workspace: Name of your Neptune workspace. If you specify it,

@@ -356,3 +356,3 @@ change the format of the project argument to "project-name" instead of "workspace-name/project-name".

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -414,3 +414,3 @@ verify_type("project", project, str)

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -428,3 +428,7 @@ verify_type("project", project, str)

result = backend_client.api.listProjectMembers(**params).response().result
return {f"{m.registeredMemberInfo.username}": ProjectMemberRoleDTO.to_domain(m.role) for m in result}
return {
f"{m.registeredMemberInfo.username}": ProjectMemberRoleDTO.to_domain(m.role)
for m in result
if m.registeredMemberInfo is not None
}
except HTTPNotFound as e:

@@ -467,3 +471,3 @@ raise ProjectNotFound(name=project_identifier) from e

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -513,3 +517,3 @@ verify_type("project", project, str)

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -525,3 +529,7 @@ verify_type("workspace", workspace, str)

result = backend_client.api.listOrganizationMembers(**params).response().result
return {f"{m.registeredMemberInfo.username}": WorkspaceMemberRoleDTO.to_domain(m.role) for m in result}
return {
f"{m.registeredMemberInfo.username}": WorkspaceMemberRoleDTO.to_domain(m.role)
for m in result
if m.registeredMemberInfo is not None
}
except HTTPNotFound as e:

@@ -572,3 +580,3 @@ raise WorkspaceNotFound(workspace=workspace) from e

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -618,4 +626,4 @@ service_accounts = _get_raw_workspace_service_account_list(workspace_name=workspace, api_token=api_token)

Learn more in the docs:
- https://docs.neptune.ai/api/management/#invite_to_workspace
- https://docs.neptune.ai/management/inviting_people/
- https://docs-legacy.neptune.ai/api/management/#invite_to_workspace
- https://docs-legacy.neptune.ai/management/inviting_people/
"""

@@ -697,3 +705,3 @@ verify_type("workspace", workspace, str)

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -739,3 +747,3 @@ verify_type("project", project, str)

- "owner": can view and edit project content and members
For more information, see https://docs.neptune.ai/management/roles/
For more information, see https://docs-legacy.neptune.ai/management/roles/
workspace: Name of your Neptune workspace. If you specify it,

@@ -759,3 +767,3 @@ change the format of the project argument to "project-name" instead of "workspace-name/project-name".

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -837,3 +845,3 @@ verify_type("project", project, str)

You may also want to check the management API reference:
https://docs.neptune.ai/api/management
https://docs-legacy.neptune.ai/api/management
"""

@@ -912,3 +920,3 @@ verify_type("project", project, str)

For more, see the docs: https://docs.neptune.ai/api/management/#trash_objects
For more, see the docs: https://docs-legacy.neptune.ai/api/management/#trash_objects
"""

@@ -1086,3 +1094,3 @@ verify_type("project", project, str)

You may also want to check the management API reference:
https://docs.neptune.ai/api/management/#get_workspace_status
https://docs-legacy.neptune.ai/api/management/#get_workspace_status
"""

@@ -1089,0 +1097,0 @@ verify_type("workspace", workspace, str)

+10
-10
src/neptune/metadata_containers/metadata_container.py

@@ -378,3 +378,3 @@ #

See also the API reference:
https://docs.neptune.ai/api/universal/#assign
https://docs-legacy.neptune.ai/api/universal/#assign
"""

@@ -408,3 +408,3 @@ self._get_root_handler().assign(value, wait=wait)

See also the API reference:
https://docs.neptune.ai/api/universal#fetch
https://docs-legacy.neptune.ai/api/universal#fetch
"""

@@ -447,5 +447,5 @@ return self._get_root_handler().fetch()

Best practices - Stopping objects
https://docs.neptune.ai/usage/best_practices/#stopping-runs-and-other-objects
https://docs-legacy.neptune.ai/usage/best_practices/#stopping-runs-and-other-objects
API reference:
https://docs.neptune.ai/api/universal/#stop
https://docs-legacy.neptune.ai/api/universal/#stop
"""

@@ -501,3 +501,3 @@ verify_type("seconds", seconds, (float, int, type(None)))

See also the API reference:
https://docs.neptune.ai/api/universal/#get_structure
https://docs-legacy.neptune.ai/api/universal/#get_structure
"""

@@ -511,3 +511,3 @@ return self._structure.get_structure().to_dict()

See also: https://docs.neptune.ai/api/universal/#print_structure
See also: https://docs-legacy.neptune.ai/api/universal/#print_structure
"""

@@ -588,3 +588,3 @@ self._print_structure_impl(self.get_structure(), indent=0)

See also the API reference:
https://docs.neptune.ai/api/universal/#pop
https://docs-legacy.neptune.ai/api/universal/#pop
"""

@@ -609,3 +609,3 @@ verify_type("path", path, str)

See also the API reference:
https://docs.neptune.ai/api/universal/#wait
https://docs-legacy.neptune.ai/api/universal/#wait
"""

@@ -638,3 +638,3 @@ with self._lock:

See also the API reference:
https://docs.neptune.ai/api/universal/#sync
https://docs-legacy.neptune.ai/api/universal/#sync
"""

@@ -662,3 +662,3 @@ with self._lock:

API reference: https://docs.neptune.ai/api/universal/#get_url
API reference: https://docs-legacy.neptune.ai/api/universal/#get_url
"""

@@ -665,0 +665,0 @@ ...

+5
-5
src/neptune/metadata_containers/model_version.py

@@ -71,3 +71,3 @@ #

for runs. You can use the parent Model object to store metadata that is common to all versions of the model.
To learn more about model registry, see the docs: https://docs.neptune.ai/model_registry/overview/
To learn more about model registry, see the docs: https://docs-legacy.neptune.ai/model_registry/overview/

@@ -158,5 +158,5 @@ To manage the stage of a model version, use its `change_stage()` method or use the menu in the web app.

Initializing a model version:
https://docs.neptune.ai/api/neptune#init_model_version
https://docs-legacy.neptune.ai/api/neptune#init_model_version
ModelVersion class reference:
https://docs.neptune.ai/api/model_version/
https://docs-legacy.neptune.ai/api/model_version/
"""

@@ -278,5 +278,5 @@

Learn more about stage management in the docs:
https://docs.neptune.ai/model_registry/managing_stage/
https://docs-legacy.neptune.ai/model_registry/managing_stage/
API reference:
https://docs.neptune.ai/api/model_version/#change_stage
https://docs-legacy.neptune.ai/api/model_version/#change_stage
"""

@@ -283,0 +283,0 @@ mapped_stage = ModelVersionStage(stage)

+5
-5
src/neptune/metadata_containers/model.py

@@ -81,3 +81,3 @@ #

but you can assign metadata to the Model object just like you can for runs.
To learn more about model registry, see the docs: https://docs.neptune.ai/model_registry/overview/
To learn more about model registry, see the docs: https://docs-legacy.neptune.ai/model_registry/overview/

@@ -163,5 +163,5 @@ You can also use the Model object as a context manager (see examples).

Initializing a model:
https://docs.neptune.ai/api/neptune#init_model
https://docs-legacy.neptune.ai/api/neptune#init_model
Model class reference:
https://docs.neptune.ai/api/model
https://docs-legacy.neptune.ai/api/model
"""

@@ -283,3 +283,3 @@

Args:
query: NQL query string. Syntax: https://docs.neptune.ai/usage/nql/
query: NQL query string. Syntax: https://docs-legacy.neptune.ai/usage/nql/
Example: `"(model_size: float > 100) AND (backbone: string = VGG)"`.

@@ -323,3 +323,3 @@ columns: Names of columns to include in the table, as a list of field names.

See also the API referene:
https://docs.neptune.ai/api/model/#fetch_model_versions_table
https://docs-legacy.neptune.ai/api/model/#fetch_model_versions_table
"""

@@ -326,0 +326,0 @@ verify_type("query", query, (str, type(None)))

+7
-7
src/neptune/metadata_containers/project.py

@@ -69,3 +69,3 @@ #

Note: If you want to instead create a project, use the
[`management.create_project()`](https://docs.neptune.ai/api/management/#create_project) function.
[`management.create_project()`](https://docs-legacy.neptune.ai/api/management/#create_project) function.

@@ -134,5 +134,5 @@ You can also use the Project object as a context manager (see examples).

Initializing a project:
https://docs.neptune.ai/api/neptune#init_project
https://docs-legacy.neptune.ai/api/neptune#init_project
Project class reference:
https://docs.neptune.ai/api/project/
https://docs-legacy.neptune.ai/api/project/
"""

@@ -217,3 +217,3 @@

Args:
query: NQL query string. Syntax: https://docs.neptune.ai/usage/nql/
query: NQL query string. Syntax: https://docs-legacy.neptune.ai/usage/nql/
Example: `"(accuracy: float > 0.88) AND (loss: float < 0.2)"`.

@@ -294,3 +294,3 @@ Exclusive with the `id`, `state`, `owner`, and `tag` parameters.

See also the API reference in the docs:
https://docs.neptune.ai/api/project#fetch_runs_table
https://docs-legacy.neptune.ai/api/project#fetch_runs_table
"""

@@ -353,3 +353,3 @@

Args:
query: NQL query string. Syntax: https://docs.neptune.ai/usage/nql/
query: NQL query string. Syntax: https://docs-legacy.neptune.ai/usage/nql/
Example: `"(model_size: float > 100) AND (backbone: string = VGG)"`.

@@ -399,3 +399,3 @@ trashed: Whether to retrieve trashed models.

See also the API reference in the docs:
https://docs.neptune.ai/api/project#fetch_models_table
https://docs-legacy.neptune.ai/api/project#fetch_models_table
"""

@@ -402,0 +402,0 @@ verify_type("query", query, (str, type(None)))

+8
-8
src/neptune/metadata_containers/run.py

@@ -267,15 +267,15 @@ #

Initializing a run:
https://docs.neptune.ai/api/neptune#init_run
https://docs-legacy.neptune.ai/api/neptune#init_run
Run class reference:
https://docs.neptune.ai/api/run/
https://docs-legacy.neptune.ai/api/run/
Essential logging methods:
https://docs.neptune.ai/logging/methods/
https://docs-legacy.neptune.ai/logging/methods/
Resuming a run:
https://docs.neptune.ai/logging/to_existing_object/
https://docs-legacy.neptune.ai/logging/to_existing_object/
Setting a custom run ID:
https://docs.neptune.ai/logging/custom_run_id/
https://docs-legacy.neptune.ai/logging/custom_run_id/
Logging to multiple runs at once:
https://docs.neptune.ai/logging/to_multiple_objects/
https://docs-legacy.neptune.ai/logging/to_multiple_objects/
Accessing the run from multiple places:
https://docs.neptune.ai/logging/from_multiple_places/
https://docs-legacy.neptune.ai/logging/from_multiple_places/
"""

@@ -574,3 +574,3 @@

" NOTE: To track the source files, pass their paths to the 'source_code'"
" argument. For help, see: https://docs.neptune.ai/logging/source_code/",
" argument. For help, see: https://docs-legacy.neptune.ai/logging/source_code/",
exception=NeptuneWarning,

@@ -577,0 +577,0 @@ )

+7
-7
src/neptune/types/atoms/file.py

@@ -109,3 +109,3 @@ #

For more, see the documentation: https://docs.neptune.ai/api/field_types#from_path
For more, see the documentation: https://docs-legacy.neptune.ai/api/field_types#from_path
"""

@@ -137,3 +137,3 @@ verify_type("path", path, str)

.. _from_content docs page:
https://docs.neptune.ai/api/field_types#from_content
https://docs-legacy.neptune.ai/api/field_types#from_content
"""

@@ -165,3 +165,3 @@ verify_type("content", content, (bytes, str, type(None)))

See also:
- from_stream() documentation: https://docs.neptune.ai/api/field_types#from_stream
- from_stream() documentation: https://docs-legacy.neptune.ai/api/field_types#from_stream
- IOBase documentation: https://docs.python.org/3/library/io.html#io.IOBase

@@ -213,4 +213,4 @@ """

See also the docs:
- How to log images: https://docs.neptune.ai/logging/images/
- API referene: https://docs.neptune.ai/api/field_types#as_image
- How to log images: https://docs-legacy.neptune.ai/logging/images/
- API referene: https://docs-legacy.neptune.ai/api/field_types#as_image
"""

@@ -263,3 +263,3 @@ content_bytes = get_image_content(image, autoscale=autoscale)

.. _as_html docs page:
https://docs.neptune.ai/api/field_types#as_html
https://docs-legacy.neptune.ai/api/field_types#as_html
"""

@@ -295,3 +295,3 @@ content = get_html_content(chart, **kwargs)

.. _as_pickle docs page:
https://docs.neptune.ai/api/field_types#as_pickle
https://docs-legacy.neptune.ai/api/field_types#as_pickle
"""

@@ -298,0 +298,0 @@ content = get_pickle_content(obj)

+2
-2
src/neptune/utils.py

@@ -75,3 +75,3 @@ #

For more information, see:
https://docs.neptune.ai/api/utils/#stringify_unsupported
https://docs-legacy.neptune.ai/api/utils/#stringify_unsupported
"""

@@ -100,3 +100,3 @@ if isinstance(value, MutableMapping):

For more information, see:
https://docs.neptune.ai/api/utils/stop_synchronization_callback/
https://docs-legacy.neptune.ai/api/utils/stop_synchronization_callback/
"""

@@ -103,0 +103,0 @@ logger.error(

+2
-2
src/neptune/version.py

@@ -49,3 +49,3 @@ #

"Uninstall each of them and then install only the new 'neptune' package. For more information, "
"see https://docs.neptune.ai/setup/upgrading/"
"see https://docs-legacy.neptune.ai/setup/upgrading/"
)

@@ -57,3 +57,3 @@ elif neptune_version is not None:

"The 'neptune-client' package has been deprecated and will be removed in the future. Install "
"the 'neptune' package instead. For more, see https://docs.neptune.ai/setup/upgrading/"
"the 'neptune' package instead. For more, see https://docs-legacy.neptune.ai/setup/upgrading/"
)

@@ -60,0 +60,0 @@ return neptune_client_version