Skip to content

Commit d52b0b9

Browse files
authored
remove all final mentions of bionemo framework2 (NVIDIA-BioNeMo#1652)
### Description This commit does a replacement of all mentions of BioNeMo Framework to BioNeMo Recipes. It also removes old documentation referencing NeMo2 and previous dependencies of Framework. ### Type of changes <!-- Mark the relevant option with an [x] --> - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Refactor - [X ] Documentation update - [ ] Other (please describe): ### CI Pipeline Configuration Configure CI behavior by applying the relevant labels. By default, only basic unit tests are run. - [ciflow:skip](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:skip) - Skip all CI tests for this PR - [ciflow:notebooks](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:notebooks) - Run Jupyter notebooks execution tests - [ciflow:slow](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:slow) - Run slow single GPU integration tests marked as @pytest.mark.slow - [ciflow:all](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:all) - Run all tests, including unit tests, slow tests, notebooks, and every recipe/model directory. Unit tests marked as `@pytest.mark.multi_gpu` or `@pytest.mark.distributed` are not run in the PR pipeline. For more details, see [CONTRIBUTING](CONTRIBUTING.md) > [!NOTE] > By default, only basic unit tests are run. Add appropriate labels to enable an additional test coverage. #### Authorizing CI Runs We use [copy-pr-bot](https://docs.gha-runners.nvidia.com/apps/copy-pr-bot/#automation) to manage authorization of CI runs on NVIDIA's compute resources. - If a pull request is opened by a trusted user and contains only trusted changes, the pull request's code will automatically be copied to a pull-request/ prefixed branch in the source repository (e.g. pull-request/123) - If a pull request is opened by an untrusted user or contains untrusted changes, an NVIDIA org member must leave an `/ok to test` comment on the pull request to trigger CI. This will need to be done for each new commit. #### Triggering Code Rabbit AI Review To trigger a code review from code rabbit, comment on a pull request with one of these commands: - @coderabbitai review - Triggers a standard review - @coderabbitai full review - Triggers a comprehensive review See https://docs.coderabbit.ai/reference/review-commands for a full list of commands. ### Pre-submit Checklist <!--- Ensure all items are completed before submitting --> - [ ] I have tested these changes locally - [ ] I have updated the documentation accordingly - [ ] I have added/updated tests as needed - [ ] All existing tests pass successfully --------- Signed-off-by: Zoey Zhang <zozhang@nvidia.com>
1 parent 5f1cacd commit d52b0b9

24 files changed

Lines changed: 36 additions & 816 deletions

File tree

.github/ISSUE_TEMPLATE/bug-report.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ body:
1313
- type: input
1414
id: version
1515
attributes:
16-
label: BioNeMo Framework Version
16+
label: BioNeMo Recipes Version
1717
description: |
1818
**What version or commit hash of the framework are you using?**
1919
@@ -89,8 +89,8 @@ body:
8989
id: docker-image-info
9090
attributes:
9191
label: Docker Image
92-
description: If the issue occurred in a container, provide the docker image name. Visit [BioNeMo Framework NGC website](https://catalog.ngc.nvidia.com/orgs/nvidia/teams/clara/containers/bionemo-framework/tags) for available images.
93-
placeholder: e.g., nvcr.io/nvidia/clara/bionemo-framework:2.2
92+
description: If the issue occurred in a container, provide the docker image name. Visit the [PyTorch NGC Container Registry](https://catalog.ngc.nvidia.com/orgs/nvidia/containers/pytorch) for available images.
93+
placeholder: e.g., nvcr.io/nvidia/pytorch:26.05-py3
9494
validations:
9595
required: false
9696

.github/ISSUE_TEMPLATE/feature-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ body:
1717
- type: input
1818
id: version
1919
attributes:
20-
label: BioNeMo Framework Version
20+
label: BioNeMo Recipes Version
2121
description: What version or commit hash of the framework are you using? Please, specify a commit hash or version tag. Do not use 'latest', 'ToT' or 'nightly' as a reference.
2222

2323
placeholder: commit-hash or version tag, ie v1.2.3.

.github/nv-slack-bot.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,20 @@
11
$schema: https://public.gha-runners.nvidia.com/nv-slack-bot/schemas/config-v1.json
22
enabled: true
33
notifications:
4-
# Send a slack notification when BioNeMo Framework nightly CI fails
5-
- name: "BioNeMo Framework Nightly CI Failed"
4+
# Send a slack notification when BioNeMo Recipes nightly CI fails
5+
- name: "BioNeMo Recipes Nightly CI Failed"
66
event: workflow_run
77
slack:
88
nvidia:
99
channels:
1010
- id: C0832RNTR09 # bionemo-fw-ci-alerts
1111
match: >
1212
workflow_run.conclusion = "failure"
13-
and workflow_run.name = "BioNeMo Framework CI"
13+
and workflow_run.name = "BioNeMo Recipes CI"
1414
and workflow_run.event = "schedule"
1515
message:
1616
body: |
17-
<{{url}}|BioNeMo Framework nightly CI "{{name}}"> failed
17+
<{{url}}|BioNeMo Recipes nightly CI "{{name}}"> failed
1818
vars:
1919
url: workflow_run.html_url
2020
name: workflow_run.name

docs/docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
- [Home](index.md)
2-
- [BioNeMo Framework](main/)
2+
- [BioNeMo Recipes](main/)
33
- [Models](models/)
Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,16 +11,12 @@ while also providing a high degree of freedom and flexibility for users.
1111
## How do I install BioNeMo Recipes?
1212

1313
You can install individual recipe directories from within BioNeMo Recipes by following the corresponding
14-
README pages the [BioNeMo Recipes GitHub](https://github.com/NVIDIA-BioNeMo/bionemo-framework). Please note that this is a
15-
beta feature and may require some additional effort to install seamlessly. We are actively working on testing this
16-
functionality and expect it will be a fully supported feature in future releases. You can review our
17-
[release notes](../about/releasenotes-fw.md) to stay up to
18-
date on our releases.
14+
README pages the [BioNeMo Recipes GitHub](https://github.com/NVIDIA-BioNeMo/bionemo-framework).
1915

2016
## What are the system requirements for BioNeMo Recipes?
2117

2218
Generally, BioNeMo Recipes should run on any NVIDIA GPU with Compute Capability ≥8.0. For a full list of supported
23-
hardware, refer to the [Hardware and Software Prerequisites](../getting-started/pre-reqs.md).
19+
hardware, refer to the [Hardware and Software Prerequisites](getting-started/pre-reqs.md).
2420

2521
## Can I contribute code or models to BioNeMo Recipes?
2622

@@ -33,8 +29,8 @@ tokenizers, custom architecture blocks, and other reusable features over end-to-
3329
consider end-to-end model implementations on a case-by-case basis. If you're interested in this contribution of this
3430
kind, we recommend [reaching out to us](https://www.nvidia.com/en-us/industries/healthcare/contact-sales/) first
3531

36-
For more information about external contributions, refer to the [Contributing](../contributing/contributing.md) and
37-
[Code Review](../contributing/code-review.md) pages.
32+
For more information about external contributions, refer to the [Contributing](contributing/contributing.md) and
33+
[Code Review](contributing/code-review.md) pages.
3834

3935
## How do I report bugs or suggest new features?
4036

docs/docs/main/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,4 @@
44
- [Tutorials](examples/)
55
- [Data Sets](datasets/)
66
- [Contributing](contributing/)
7-
- [References](references/)
7+
- [Frequently Asked Questions](FAQ.md)

docs/docs/main/about/SUMMARY.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1 @@
11
- [Overview](overview.md)
2-
- [Background](background/)
3-
- [Release Notes](releasenotes-fw.md)

docs/docs/main/about/background/SUMMARY.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

docs/docs/main/about/background/megatron_datasets.md

Lines changed: 0 additions & 80 deletions
This file was deleted.

0 commit comments

Comments
 (0)