Skip to content

Fix stale src/ paths in docs and rewrite dead README sections - #120

Merged
anagainaru merged 1 commit into
mainfrom
cleanup
Aug 17, 2026
Merged

Fix stale src/ paths in docs and rewrite dead README sections#120
anagainaru merged 1 commit into
mainfrom
cleanup

Conversation

@anagainaru

Copy link
Copy Markdown
Collaborator

Docs-only cleanup: several paths still pointed at src/<subpackage>/ from before
the package moved under src/apeiron/. No Python imports were affected.

  • Deployment READMEs (Frontier, Perlmutter): the source ./src/deployment/.../install_venv.sh
    and sbatch src/deployment/.../mnist_example.sbatch commands were broken as
    written — repointed to src/apeiron/deployment/....
  • Test docstrings (6 files) and the header comment in examples/mnist/model.py:
    repointed to their real module paths.
  • README.md: "What main.py Does", "Tuning Tips", and "Output" described a
    codebase that no longer exists — DummyCNN_MNIST, CL(), One_task_CL,
    update_CL_, n_epoch, and return_score appear in zero Python files in the
    repo. Rewrote all three against the actual src/main.py pipeline (config →
    logger → get_example harness → ContinuousMonitorContinuousTrainer on
    drift), with pointers to docs/architecture.md and docs/drift_detectors.md.

python -m src.main / src.drift_only / src.cl_only are unchanged — those
modules do live directly at src/. ruff check and ruff format --check pass.

Note the README rewrite is the one non-mechanical change here, so it's worth a reviewer's eye; the other nine files are pure path corrections.

@anagainaru
anagainaru requested a review from rz4 August 13, 2026 20:58
@anagainaru anagainaru added the documentation Improvements or additions to documentation label Aug 13, 2026
@anagainaru
anagainaru merged commit 8d98a02 into main Aug 17, 2026
3 checks passed
@anagainaru
anagainaru deleted the cleanup branch August 17, 2026 20:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants