Skip to content

Commit 03928bc

Browse files
committed
Small fixes
1 parent a501b79 commit 03928bc

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

DEVELOPMENT.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Notes for contributors extending the exporter (new loaders/targets, schema tweak
55
## Local environment
66
- Install deps with `uv sync --dev`.
77
- Run checks with `uv run pre-commit run --all-files`.
8+
- Add pre-commit to git hooks with `uv run pre-commit install`.
89
- Run tests with `uv run pytest -v`. Integration-style tests need:
910
- `NEPTUNE2_E2E_API_TOKEN`, `NEPTUNE2_E2E_PROJECT`
1011
- `NEPTUNE3_E2E_API_TOKEN`, `NEPTUNE3_E2E_PROJECT`
@@ -41,7 +42,8 @@ Exports are resumable but not incremental: reruns skip completed runs, so new da
4142
- Continue batching to avoid large in-memory frames; follow the `download_*` generator pattern.
4243
- **File handling**:
4344
- Artifacts are stored under `--files-path/<sanitized_project_id>/...`; keep the relative paths in `file_value.path` stable so loaders can find the payloads.
44-
- Fork metadata exists only in Neptune 3.x exports; MLflow ignores parents and W&B supports forks in a limited/preview fashion—avoid relying on strict fidelity.
45+
- **Forking**:
46+
- Fork metadata exists only in Neptune 3.x exports. W&B supports forks only in a limited/preview fashion—avoid relying on strict fidelity. MLflow does not support forking and saves parents as tags instead.
4547

4648
## Testing notes
4749
- Prefer function-style pytest tests (no classes) and `unittest.mock.Mock` for doubles.

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,10 @@ All records use `src/neptune_exporter/model.py::SCHEMA`:
115115
- Experiments are named `<project_id>/<experiment_name>` (prefixed with `--name-prefix` if provided).
116116
- Attribute paths are sanitized to MLflow’s key rules (alphanumeric + `_-. /`, max 250 chars).
117117
- Metrics/series use the integer step; files are uploaded as artifacts from `--files-path`.
118+
- MLflow saves parentship/fork relationships as tags (no native forks).
118119
- W&B loader:
119120
- Requires `--wandb-entity`; project names derive from `project_id` (plus optional `--name-prefix`, sanitized).
120-
- String series become W&B Tables, histograms use `wandb.Histogram`, files/file series become artifacts. Forked runs from Neptune 3.x are handled best-effort (MLflow ignores parents; W&B has limited preview support).
121+
- String series become W&B Tables, histograms use `wandb.Histogram`, files/file series become artifacts. Forked runs from Neptune 3.x are handled best-effort (W&B has limited preview support).
121122
- If a target run with the same name already exists in the experiment/project, the loader skips uploading that run to avoid duplicates.
122123

123124
## Experiment/run mapping to targets

0 commit comments

Comments
 (0)