Skip to content

Add DATASET_VERSION to params, upload, and download#103

Open
jmoraispk wants to merge 2 commits into
mainfrom
upload-dataset-version
Open

Add DATASET_VERSION to params, upload, and download#103
jmoraispk wants to merge 2 commits into
mainfrom
upload-dataset-version

Conversation

@jmoraispk
Copy link
Copy Markdown
Collaborator

@jmoraispk jmoraispk commented Apr 29, 2026

Summary

Implements the dataset versioning scheme discussed with @sohamd22.

Three changes:

  1. consts.py — adds DATASET_VERSION_PARAM_NAME = "dataset_version" alongside the existing DATASET_VERSION = "4a" constant
  2. All three converters (Sionna RT, AODT, Wireless InSite) — write dataset_version into params.json at conversion time, so every scenario carries its schema version on disk
  3. upload.pydmVersion now reads from the dedicated dataset_version field in params (falls back to DATASET_VERSION constant if absent, for backwards compatibility)
  4. download.pydownload() gains a version= keyword argument (default DATASET_VERSION) appended to the URL as ?version=4a, so the server can route to the correct dataset build

Open question for @sohamd22

Is including dataset_version in the upload call redundant given the server already reads it from params.json? Current thinking: keep it in both places — the params file is the canonical source, but passing it explicitly in the upload call gives the server a fast path without having to parse the params file first, and makes the intent obvious at the API boundary. Happy to drop it from the upload if you prefer simpler server-side logic.

Test plan

  • Convert a scenario and verify params.json contains "dataset_version": "4a"
  • Confirm upload() sends "dmVersion": "4a" in advanced_params
  • Confirm download("scenario_name") hits ?version=4a by default
  • Confirm download("scenario_name", version="4b") hits ?version=4b

jmoraispk and others added 2 commits April 29, 2026 10:42
DATASET_VERSION ("4a") is sent to the server on download requests so it
can return the correct dataset build, independently of the software version.
Increment the letter suffix (4a → 4b) when the on-disk format changes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1. consts.py: add DATASET_VERSION_PARAM_NAME = "dataset_version"
2. All three converters: write DATASET_VERSION into params.json
   alongside VERSION so every converted scenario carries its dataset
   schema version on disk
3. upload.py: read dmVersion from the dedicated dataset_version field
   (falls back to DATASET_VERSION constant if field is absent)
4. download.py: add version= parameter (default DATASET_VERSION) to
   download() and _download_url(); appended as ?version=<v> so the
   server can return the matching dataset build

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@jmoraispk jmoraispk changed the title Add DATASET_VERSION constant for independent dataset schema versioning Add DATASET_VERSION to params, upload, and download Apr 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant