Skip to content

Commit 5902e53

Browse files
committed
Merge branch 'main' into ss/readme
2 parents 56de08a + ae1021a commit 5902e53

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,18 @@ Neptune Exporter is a CLI tool to move Neptune experiments (version `2.x` or `3.
1919
- MLflow tracking URI, set with `MLFLOW_TRACKING_URI` or `--mlflow-tracking-uri`.
2020
- W&B entity and API key, set with `WANDB_ENTITY`/`--wandb-entity` and `WANDB_API_KEY`/`--wandb-api-key`.
2121

22+
## Installation
23+
24+
> [!IMPORTANT]
25+
> This project is not published on PyPI. Clone the Git repository and run it directly with `uv`.
26+
2227
Install dependencies in the repo:
2328

2429
```bash
2530
uv sync
2631
```
2732

28-
Run all CLI commands via uv:
33+
Run the CLI:
2934

3035
```bash
3136
uv run neptune-exporter --help
@@ -194,7 +199,7 @@ For details on Neptune attribute types, see the [documentation](https://docs.nep
194199

195200
## Summary command
196201

197-
`uv run neptune-exporter summary` reads parquet files and prints counts of projects/runs, attribute type breakdowns, and basic step stats to help you verify the export before loading.
202+
The `uv run neptune-exporter summary` command reads parquet files and prints counts of projects and runs, attribute type breakdowns, and basic step stats to help you verify the export before loading.
198203

199204
---
200205

0 commit comments

Comments
 (0)