Skip to content

docs: science projects use dataset/ not data/ (workspace convention)#70

Merged
Jammy2211 merged 2 commits into
mainfrom
docs/project-dataset-folder-convention
Jul 15, 2026
Merged

docs: science projects use dataset/ not data/ (workspace convention)#70
Jammy2211 merged 2 commits into
mainfrom
docs/project-dataset-folder-convention

Conversation

@Jammy2211

Copy link
Copy Markdown
Collaborator

start-new-project scaffolded datasets under data/, diverging from the workspace convention dataset/ — used by this clone, every autolens_workspace example, PyAutoReduce's scripts/docs, and the --sample/--dataset CLI idiom.

A project on data/ silently breaks scripts, hpc/sync's DATA_DIRS, and anything copied from the workspace (surfaced in a real project: nothing synced to HPC until DATA_DIRS was hand-patched).

Switches the scaffold tree, .gitignore, manifest example and Publish gate to dataset/, and adds a pedantic note telling the agent never to use data/ nor accept it silently. project.yaml's data: key is untouched (metadata, not the folder). Also un-ignores dataset/**/info.json.

PyAutoReduce needs no change — already dataset/ throughout.

🤖 Generated with Claude Code

Jammy2211 and others added 2 commits July 15, 2026 08:51
On CPU the correct accelerator depends on the source model, and the docs
previously implied JAX was GPU-only ("## JAX on GPU") while telling users to set
number_of_cores to their core count unconditionally. That combination leads
straight to the slow path: a real SLaM run spent >12h stuck in source_lp.

The rule, from autolens_workspace's cpu_fast_modeling.py:

- Parametric source (source_lp): JAX (use_jax=True) vectorises and parallelises
  well on CPU; JAX disables multiprocessing so number_of_cores is left unset.
- Pixelized source (source_pix/light/mass): sparse operator formalism
  (dataset.apply_sparse_operator_cpu()) + use_jax=False + number_of_cores=N.
  It is numba-based and does not support JAX, so the two never combine.

A SLaM pipeline spans both regimes -> two SettingsSearch objects, two datasets.

- al_configure_search: new "Branch — CPU acceleration" section; corrected the
  misleading number_of_cores bullet.
- init-slam: pointer at Step 3, since the workspace SLaM scripts don't do this.
- wiki/core/operations/hpc: replaced "CPU parallelism"/"JAX on GPU" framing with
  the two-regime table; added cpu_fast_modeling.py as a source.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…pedantic)

start-new-project scaffolded datasets under data/, diverging from the PyAuto
workspace convention (dataset/) used by this clone, every autolens_workspace
example, PyAutoReduce's scripts/docs, and the --sample/--dataset CLI idiom
(dataset/<sample>/<dataset_name>/). A project on data/ silently breaks scripts,
hpc/sync DATA_DIRS and anything copied from the workspace.

Switch the scaffold, .gitignore, manifest example and Publish gate to dataset/,
and add a pedantic note telling the agent never to use data/ or accept it
silently. project.yaml's  metadata key is unchanged (different thing).
Also un-ignore dataset/**/info.json (small, needed to reproduce).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HD3ZkpFRydshFLeu2V6xDi
@Jammy2211
Jammy2211 merged commit 117928c into main Jul 15, 2026
1 check passed
@Jammy2211
Jammy2211 deleted the docs/project-dataset-folder-convention branch July 15, 2026 08:14
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