Skip to content

How to Train a Model with AtomWorks tutorial#82

Draft
rclune wants to merge 1 commit intoproductionfrom
docs_build_a_model_tutorial
Draft

How to Train a Model with AtomWorks tutorial#82
rclune wants to merge 1 commit intoproductionfrom
docs_build_a_model_tutorial

Conversation

@rclune
Copy link
Copy Markdown
Member

@rclune rclune commented Apr 22, 2026

Initial commit:

  • tutorial markdown file
  • scripts needed to parse the data and train the model
  • Addition of myst_parser for Markdown file support, updated docs_requirements.txt to match

📋 PR Checklist

  • This PR is tagged as a draft if it is still under development and not ready for review.

    This avoids auto-triggering the slower tests in the CI and needlessly wasting resources.

  • I have ensured that all my commits follow angular commit message conventions.

    Format: <type>[optional scope]: <subject>
    Example: fix(af3): add missing crop transform to the af3 pipeline

    This affects semantic versioning as follows:

    • fix: patch version increment (0.0.1 → 0.0.2)
    • feat: minor version increment (0.0.1 → 0.1.0)
    • BREAKING CHANGE: major version increment (0.0.1 → 1.0.0)
    • All other types do not affect versioning

    The format ensures readable changelogs through auto-generation from commit messages.

  • I have run make format on the codebase before submitting the PR (this autoformats the code and lints it).

  • I have named the PR in angular PR message format as well (c.f. above), with a sensible tag line that summarizes all the changes in the PR.

    This is useful as the name of the PR is the default name of the commit that will be used if you merge with a squash & merge.
    Format: <type>[optional scope]: <subject>
    Example: fix(af3): add missing crop transform to the af3 pipeline


ℹ️ PR Description

What changes were made and why?

How were the changes tested?

Additional Notes

Initial commit:
- tutorial markdown file
- scripts needed to parse the data and train the model
- Addition of myst_parser for Markdown file support, updated docs_requirements.txt to match
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