Neptune Fetcher [DEPRECATED]
[!IMPORTANT] This package is deprecated and no longer actively developed.
Use
neptune-queryinstead:pip uninstall -y neptune-fetcher && pip install "neptune-query>=1.0.0,<2.0.0"For instructions, see the migration guide.
Neptune Fetcher is a read-only API for querying metadata logged with the Neptune Python client. The separation makes it safer and more efficient to fetch data from Neptune.
With the Fetcher API, you can:
- List experiments, runs, and attributes of a project.
- Fetch experiment or run metadata as a data frame.
- Define filters to fetch experiments, runs, and attributes that meet certain criteria.
[!NOTE] For the Python API corresponding to Neptune 2.x, see neptune-client.
Documentation
Installation
pip install -U neptune-fetcher
Set your Neptune API token and project name as environment variables:
export NEPTUNE_API_TOKEN="h0dHBzOi8aHR0cHM.4kl0jvYh3Kb8...ifQ=="
export NEPTUNE_PROJECT="workspace-name/project-name"
For help, see Get started in the Neptune documentation.
Note: To change the token or project, you can set the context directly in the code. This way, you can work with multiple projects at the same time.
Usage
Import the alpha module:
import neptune_fetcher.alpha as npt
To fetch experiment metadata from your project, use the fetch_experiments_table() function.
- To filter experiments to return, use the
experimentsparameter. - To specify attributes to include as columns, use the
attributesparameter.
npt.fetch_experiments_table(
experiments=["exp_ergwq", "exp_qgguv"],
attributes=["metrics/train_accuracy", "metrics/train_loss"],
)
metrics/train_accuracy metrics/train_loss
last last
experiment
exp_ergwq 0.278149 0.336344
exp_qgguv 0.160260 0.790268
To fetch values at each step, use fetch_metrics():
npt.fetch_metrics(
experiments=r"exp.*",
attributes=r".*metric.*/val_.+",
)
experiment step metrics/val_accuracy metrics/val_loss
0 exp_dczjz 0 0.432187 0.823375
1 exp_dczjz 1 0.649685 0.971732
2 exp_dczjz 2 0.760142 0.154741
3 exp_dczjz 3 0.719508 0.504652
4 exp_dczjz 4 0.180321 0.503800
5 exp_hgctc 0 0.012390 0.171790
6 exp_hgctc 1 0.392041 0.768675
7 exp_hgctc 2 None 0.847072
8 exp_hgctc 3 0.479945 0.323537
9 exp_hgctc 4 0.102646 0.055511
You can define detailed criteria for which experiments to search or which attributes to return.
For instructions, see the how-to guides in the Neptune documentation:
Old Fetcher API
For documentation related to the previous version of the Fetcher API, see the docs/old/ directory:
To update your code to the new version, see Migrate to Fetcher Alpha in the Neptune documentation.
License
This project is licensed under the Apache License Version 2.0. For details, see Apache License Version 2.0.
1 maintainer
Release files for neptune-fetcher 0.23.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| neptune_fetcher-0.23.0.tar.gz | 69.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| neptune_fetcher-0.23.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 179.3 kB
Release files / neptune_fetcher-0.23.0.tar.gz
| Download URL | neptune_fetcher-0.23.0.tar.gz |
|---|---|
| Size | 69.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a901fde59d8d8eb33e2a1547a1b099c74d42b8e84a7d043adb32eef3d67a7401
|
|
BLAKE2b-256 checksum How to use checksums |
524dcf83fca1ce1c71d2210473c04d33b9903149dbf00a5ac51d2e231aeaa4a5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
Release files / neptune_fetcher-0.23.0-py3-none-any.whl
| Download URL | neptune_fetcher-0.23.0-py3-none-any.whl |
|---|---|
| Size | 109.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8f3ec9bafdc35c34a0cc82c7de7fcebdace7a94e662805a0d6ce745d58076486
|
|
BLAKE2b-256 checksum How to use checksums |
105a304c55450d84d479d83dcd7b3c2b9f1d22f1156b3650c237a7fdefa121b8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.8
|
