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

feat: introducing the experimental package and refactoring test structure #433

Open
wants to merge 7 commits into
base: main
Choose a base branch
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
│   │   └── datasets_test.py        <----- tests colocated with module
│   └── experimental/               <----- mirrors the structure around it
│       ├── <proj-name>/
│           ├── model.py         <----- 
│           └── model_test.py    <----- 
└── 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 (Needs more investigation)
  • functional tests will stay outside for convenience

@github-actions github-actions bot added the CI label Dec 6, 2024
@github-actions github-actions bot added Utils documentation Improvements or additions to documentation labels Jan 13, 2025
@terrykong terrykong added the Run CICD Set + un-set to retrigger label Jan 13, 2025
@terrykong terrykong changed the title Tk/experimental feat: introducing the experimental package and refactoring test structure Jan 14, 2025
@terrykong terrykong changed the title feat: introducing the experimental package and refactoring test structure feat: introducing the experimental package and refactoring test structure Jan 14, 2025
Signed-off-by: Terry Kong <[email protected]>
Signed-off-by: Terry Kong <[email protected]>
Signed-off-by: Terry Kong <[email protected]>
pre-commit-ci bot and others added 2 commits January 14, 2025 07:41
for more information, see https://pre-commit.ci

Signed-off-by: NeMo-Aligner CI <[email protected]>
Signed-off-by: Terry Kong <[email protected]>
@github-actions github-actions bot removed the CI label Jan 14, 2025
@terrykong terrykong marked this pull request as ready for review January 14, 2025 07:42
@terrykong terrykong added Run CICD Set + un-set to retrigger and removed Run CICD Set + un-set to retrigger labels Jan 14, 2025
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 Run CICD Set + un-set to retrigger Utils
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant