Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tk/experimental #433

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

Tk/experimental #433

wants to merge 2 commits into from

Conversation

terrykong
Copy link
Collaborator

@terrykong terrykong commented Dec 6, 2024

What does this PR do ?

Introduces experimental directories but verification related to the CI will come in a follow up PR. The idea being that experimental tests are allowed to fail

Before

NeMo-Aligner/
├── docs/
│   └── user-guide/
│       └── ppo.html
├── nemo_aligner/
│   ├── algorithms/
│   └── data/
│       └── datasets.py
└── tests/
    ├── test_datasets.py
    └── functional/
        └── test_cases/
            └── dpo-llama3

Proposal

NeMo-Aligner/
├── docs/
│   ├── user-guide/
│   │   └── ppo.html
│   └── user-guide-experimental/    <----- new doc dir
│       └── new-thing.html
├── nemo_aligner/
│   ├── algorithms/
│   ├── data/
│   │   ├── datasets.py
│   │   └── test_datasets.py        <----- tests colocated with module
│   └── experimental/               <----- mirrors the structure around it
│       ├── algorithms/
│       └── data/
│           ├── datasets.py         <----- mirrored datasets
│           └── test_datasets.py    <----- mirrored test file
└── tests/
    └── functional/
        └── test_cases/
            └── dpo-llama3
  • By moving the docs out of the main dir, we can control what is rendered in the NeMo docs
  • colocating the tests in the same package makes it easier to find tests and reduces number of mirrored dirs
    • these can be filtered out when we publish to pypi
  • functional tests will stay outside for convenience

@github-actions github-actions bot added the CI label Dec 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant