Skip to content

Commit ae1021a

Browse files
authored
Make installation more explicit (#24)
1 parent 10262f3 commit ae1021a

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,25 +8,28 @@ CLI tool to move Neptune experiments (version 2.x or 3.x) to disk as parquet + f
88
- Loads parquet data into MLflow or W&B while preserving run structure (forks, steps, attributes) as closely as possible.
99
- Prints a human-readable summary of what is on disk.
1010

11-
## Requirements
12-
- Python 3.13 (managed via [uv](https://github.com/astral-sh/uv)).
13-
- Neptune credentials: `NEPTUNE_API_TOKEN` (or pass `--api-token`) and either `--project-ids` or `NEPTUNE_PROJECT`.
14-
- Target credentials when loading:
15-
- MLflow: `MLFLOW_TRACKING_URI` or `--mlflow-tracking-uri`.
16-
- W&B: `WANDB_ENTITY`/`--wandb-entity` and `WANDB_API_KEY`/`--wandb-api-key`.
11+
## Install & run locally
12+
This project is not published on PyPI. Clone the repository and run it directly with `uv`.
1713

1814
Install dependencies in the repo:
1915

2016
```bash
2117
uv sync
2218
```
2319

24-
Run all CLI commands via uv:
20+
Run the CLI:
2521

2622
```bash
2723
uv run neptune-exporter --help
2824
```
2925

26+
## Requirements
27+
- Python 3.13 (managed via [uv](https://docs.astral.sh/uv/)).
28+
- Neptune credentials: `NEPTUNE_API_TOKEN` (or pass `--api-token`) and either `--project-ids` or `NEPTUNE_PROJECT`.
29+
- Target credentials when loading:
30+
- MLflow: `MLFLOW_TRACKING_URI` or `--mlflow-tracking-uri`.
31+
- W&B: `WANDB_ENTITY`/`--wandb-entity` and `WANDB_API_KEY`/`--wandb-api-key`.
32+
3033
## Quick start
3134
1) Export Neptune data to disk (core):
3235
```bash

0 commit comments

Comments
 (0)