<div align="center">
<img src="https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Github-cover.png" width="1500" />
<h1>neptune.ai</h1>
</div>
<div align="center">
<a href="https://docs.neptune.ai/usage/quickstart/">Quickstart</a>
<span> • </span>
<a href="https://neptune.ai/">Website</a>
<span> • </span>
<a href="https://docs.neptune.ai/">Docs</a>
<span> • </span>
<a href="https://github.com/neptune-ai/examples">Examples</a>
<span> • </span>
<a href="https://neptune.ai/resources">Resource center</a>
<span> • </span>
<a href="https://neptune.ai/blog">Blog</a>
<hr />
</div>
## What is neptune.ai?
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>
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.
<a href="https://www.youtube.com/watch?v=bQzgnqM5J6U"><b>Watch a 3min explainer video →</b></a>
<a href="https://neptune.ai/demo"><b>Watch a 20min product demo →</b></a>
<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>
## 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
```
[](https://colab.research.google.com/github/neptune-ai/examples/blob/master/how-to-guides/hello-neptune/notebooks/hello_neptune.ipynb)
## 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.
<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>
**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.
<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>
**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.
<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>
**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.
<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>
**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.
<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>
## 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)
```
[](https://app.neptune.ai/common/pytorch-lightning-integration/experiments?split=tbl&dash=charts&viewId=faa75e77-5bd6-42b9-9379-863fe7a33227)
[](https://github.com/neptune-ai/examples/tree/main/integrations-and-supported-tools/pytorch-lightning/scripts)
[](https://github.com/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)
[](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/)
## 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>
Read how various customers use Neptune to <a href="https://neptune.ai/customers">improve their workflow</a>.
## 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).
## People behind
Created with :heart: by the [neptune.ai team](https://neptune.ai/jobs#team)
Raw data
{
"_id": null,
"home_page": "https://neptune.ai/",
"name": "neptune-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "MLOps, ML Experiment Tracking, ML Model Registry, ML Model Store, ML Metadata Store",
"author": "neptune.ai",
"author_email": "contact@neptune.ai",
"download_url": "https://files.pythonhosted.org/packages/24/df/d599311e4fa5f7ec82812cad6b2e3e815526cdb6fdf3fe690b9b4148294d/neptune_client-1.12.0.tar.gz",
"platform": null,
"description": "<div align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Github-cover.png\" width=\"1500\" />\n <h1>neptune.ai</h1>\n</div>\n\n<div align=\"center\">\n <a href=\"https://docs.neptune.ai/usage/quickstart/\">Quickstart</a>\n <span> \u2022 </span>\n <a href=\"https://neptune.ai/\">Website</a>\n <span> \u2022 </span>\n <a href=\"https://docs.neptune.ai/\">Docs</a>\n <span> \u2022 </span>\n <a href=\"https://github.com/neptune-ai/examples\">Examples</a>\n <span> \u2022 </span>\n <a href=\"https://neptune.ai/resources\">Resource center</a>\n <span> \u2022 </span>\n <a href=\"https://neptune.ai/blog\">Blog</a>\n \n <hr />\n</div>\n\n## What is neptune.ai?\n\nNeptune 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>\n\nWith Neptune, Data Scientists can develop production-ready models faster, and ML Engineers can access model artifacts instantly in order to deploy them to production.\n \n\n<a href=\"https://www.youtube.com/watch?v=bQzgnqM5J6U\"><b>Watch a 3min explainer video \u2192</b></a>\n \n\n<a href=\"https://neptune.ai/demo\"><b>Watch a 20min product demo \u2192</b></a>\n \n\n<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 \u2192</b></a>\n \n## Getting started\n\n**Step 1:** Create a **[free account](https://neptune.ai/register)**\n\n**Step 2:** Install the Neptune client library\n\n```bash\npip install neptune\n```\n\n**Step 3:** Add an experiment tracking snippet to your code\n\n```python\nimport neptune\n\nrun = neptune.init_run(project=\"workspace-name/project-name\")\nrun[\"parameters\"] = {\"lr\": 0.1, \"dropout\": 0.4}\nrun[\"test_accuracy\"] = 0.84\n```\n\n[](https://colab.research.google.com/github/neptune-ai/examples/blob/master/how-to-guides/hello-neptune/notebooks/hello_neptune.ipynb)\n \n\n \n## Core features\n\n**Log and display**\n\nAdd a snippet to any step of your ML pipeline once. Decide what and how you want to log. Run a million times.\n\n* <a href=\"https://docs.neptune.ai/integrations/\"><b>Any framework:</b></a> any code, fastai, PyTorch, Lightning, TensorFlow/Keras, scikit-learn, \ud83e\udd17 Transformers, XGBoost, Optuna.\n\n* <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.\n\n* <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.\n \n\n \n<div align=\"center\">\n <img border=\"0\" alt=\"all metadata metrics\" src=\"https://neptune.ai/wp-content/uploads/2023/06/log_metrics.gif\" width=\"600\">\n </a>\n</div>\n \n\n \n\n**Organize experiments**\n\nOrganize logs in a fully customizable nested structure. Display model metadata in user-defined dashboard templates.\n\n* <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.\n\n* <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.\n\n* <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.\n \n\n \n<div align=\"center\">\n <img border=\"0\" alt=\"organize dashboards\" src=\"https://neptune.ai/wp-content/uploads/2023/06/organize_custom_dashboards.gif\" width=\"600\">\n </a>\n</div>\n \n\n \n\n**Compare results**\n\nVisualize training live in the neptune.ai web app. See how different parameters and configs affect the results. Optimize models quicker.\n\n* <a href=\"https://docs.neptune.ai/app/comparison/\"><b>Compare:</b></a> learning curves, parameters, images, datasets.\n\n* <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.\n\n* <a href=\"https://docs.neptune.ai/app/runs_table/\"><b>Visualize and display:</b></a> runs table, interactive display, folder structure, dashboards.\n\n* <a href=\"https://docs.neptune.ai/tutorials/monitoring_training_live/\"><b>Monitor live:</b></a> hardware consumption metrics, GPU, CPU, memory.\n\n* <a href=\"https://docs.neptune.ai/app/group_by/\"><b>Group by:</b></a> dataset versions, parameters.\n \n\n \n<div align=\"center\">\n <img border=\"0\" alt=\"compare, search, filter\" src=\"https://neptune.ai/wp-content/uploads/2023/06/organize_search_sort_filter.gif\" width=\"600\">\n </a>\n</div>\n \n\n \n\n**Version models**\n\nVersion, review, and access production-ready models and metadata associated with them in a single place.\n\n* <a href=\"https://docs.neptune.ai/model_registry/registering_model/\"><b>Version models:</b></a> register models, create model versions, version external model artifacts.\n\n* <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.\n\n* <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.\n \n\n \n<div align=\"center\">\n <img border=\"0\" alt=\"register models\" src=\"https://neptune.ai/wp-content/uploads/2023/06/register_models.gif\" width=\"600\">\n </a>\n</div>\n \n\n \n\n**Share results**\n\nHave a single place where your team can see the results and access all models and experiments.\n\n* <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.\n\n* <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.\n\n* <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.\n\n* <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.\n \n\n \n<div align=\"center\">\n <img border=\"0\" alt=\"share persistent link\" src=\"https://neptune.ai/wp-content/uploads/2023/06/share_send_link.gif\" width=\"600\">\n </a>\n</div>\n \n\n \n## Integrate with any MLOps stack\nneptune.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, \ud83e\udd17 Transformers, fastai, Prophet, detectron2, Airflow, and more.\n\n#### <img src=\"https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/Pytorch-lightning-logo.png\" width=\"60\" /> <br> <br> PyTorch Lightning\n\nExample:\n\n```python\nfrom pytorch_lightning import Trainer\nfrom lightning.pytorch.loggers import NeptuneLogger\n\n# Create NeptuneLogger instance\nfrom neptune import ANONYMOUS_API_TOKEN\n\nneptune_logger = NeptuneLogger(\n api_key=ANONYMOUS_API_TOKEN,\n project=\"common/pytorch-lightning-integration\",\n tags=[\"training\", \"resnet\"], # optional\n)\n\n# Pass the logger to the Trainer\ntrainer = Trainer(max_epochs=10, logger=neptune_logger)\n\n# Run the Trainer\ntrainer.fit(my_model, my_dataloader)\n```\n\n[](https://app.neptune.ai/common/pytorch-lightning-integration/experiments?split=tbl&dash=charts&viewId=faa75e77-5bd6-42b9-9379-863fe7a33227)\n \n\n[](https://github.com/neptune-ai/examples/tree/main/integrations-and-supported-tools/pytorch-lightning/scripts)\n[](https://github.com/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)\n[](https://colab.research.google.com/github/neptune-ai/examples/blob/main/integrations-and-supported-tools/pytorch-lightning/notebooks/Neptune_PyTorch_Lightning.ipynb)\n[<img src=\"https://img.shields.io/badge/docs-PyTorch%20Lightning-yellow\">](https://docs.neptune.ai/integrations/lightning/)\n \n\n \n## neptune.ai is trusted by great companies\n<div align=\"center\">\n <img src=\"https://raw.githubusercontent.com/neptune-ai/neptune-client/assets/readme/github-customers.png\" width=\"1500\" />\n</div>\n \n\nRead how various customers use Neptune to <a href=\"https://neptune.ai/customers\">improve their workflow</a>.\n \n\n \n## Support\n\nIf you get stuck or simply want to talk to us about something, here are your options:\n* Check our <a href=\"https://docs.neptune.ai/getting_help/#faq\">FAQ page</a>.\n* Take a look at our <a href=\"https://neptune.ai/resources\">resource center</a>.\n* 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).\n* You can just shoot us an email at [support@neptune.ai](mailto:support@neptune.ai).\n \n\n \n## People behind\n\nCreated with :heart: by the [neptune.ai team](https://neptune.ai/jobs#team)\n\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Neptune Client",
"version": "1.12.0",
"project_urls": {
"Documentation": "https://docs.neptune.ai/",
"Homepage": "https://neptune.ai/",
"Repository": "https://github.com/neptune-ai/neptune-client",
"Tracker": "https://github.com/neptune-ai/neptune-client/issues"
},
"split_keywords": [
"mlops",
" ml experiment tracking",
" ml model registry",
" ml model store",
" ml metadata store"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9ea9881f930b7aca97ccb1e09f983572b7cac4c85cdae84bde4605fb83fb56bc",
"md5": "47a39c918798d4963f98fecc00812e2e",
"sha256": "40c6e5b4e2e958a11ddd43d4db105f29e00f9bb244fab8814163190d3b851881"
},
"downloads": -1,
"filename": "neptune_client-1.12.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "47a39c918798d4963f98fecc00812e2e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 502012,
"upload_time": "2024-10-02T08:04:08",
"upload_time_iso_8601": "2024-10-02T08:04:08.810259Z",
"url": "https://files.pythonhosted.org/packages/9e/a9/881f930b7aca97ccb1e09f983572b7cac4c85cdae84bde4605fb83fb56bc/neptune_client-1.12.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24dfd599311e4fa5f7ec82812cad6b2e3e815526cdb6fdf3fe690b9b4148294d",
"md5": "d614137e5211d76c274b6b36fc34008d",
"sha256": "72eda03f5b08537f07935a60eac5ea6f99bb0f5b2b5eea570b9fa12e0d2562c0"
},
"downloads": -1,
"filename": "neptune_client-1.12.0.tar.gz",
"has_sig": false,
"md5_digest": "d614137e5211d76c274b6b36fc34008d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 276296,
"upload_time": "2024-10-02T08:04:10",
"upload_time_iso_8601": "2024-10-02T08:04:10.779828Z",
"url": "https://files.pythonhosted.org/packages/24/df/d599311e4fa5f7ec82812cad6b2e3e815526cdb6fdf3fe690b9b4148294d/neptune_client-1.12.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 08:04:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "neptune-ai",
"github_project": "neptune-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "neptune-client"
}
JSON
