Skip to content

Commit cf7b416

Browse files
jomitchellnvyzhang123cspadespstjohntrvachov
authored
Adds CodonFM Recipe to BioNeMo Recipes (#1279)
### Description Adds the codonFM recipe Does not add top level readme edits. #### Usage <!--- How does a user interact with the changed code --> ```python TODO: Add code snippet ``` ### 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 - [ ] 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 for bionemo2 - [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 for bionemo2 - [ciflow:all](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:all) - Run all tests (unit tests, slow tests, and notebooks) for bionemo2. This label can be used to enforce running tests for all bionemo2. - [ciflow:all-recipes](https://github.com/NVIDIA/bionemo-framework/blob/main/docs/docs/main/contributing/contributing.md#ciflow:all-recipes) - Run tests for all recipes (under bionemo-recipes). This label can be used to enforce running tests for all recipes. 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. ### 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: Jonathan Mitchell <[email protected]> Co-authored-by: Yang Zhang <[email protected]> Co-authored-by: Cory Ye <[email protected]> Co-authored-by: Peter St. John <[email protected]> Co-authored-by: Timur Rvachov <[email protected]>
1 parent c62d738 commit cf7b416

File tree

114 files changed

+25645
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+25645
-0
lines changed
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
{
2+
"name": "Codo AI Dev Container",
3+
"runArgs": [
4+
"--gpus=all",
5+
"--ipc=host",
6+
"--net=host"
7+
],
8+
"hostname": "localhost",
9+
"mounts": [
10+
"source=${localEnv:HOME}/.ssh,target=/home/${localEnv:USER}/.ssh,type=bind,readonly",
11+
"source=${localEnv:HOME}/.aws,target=/home/${localEnv:USER}/.aws,type=bind,consistency=cached",
12+
"source=${localEnv:HOME}/.ngc,target=/home/${localEnv:USER}/.ngc,type=bind,consistency=cached",
13+
"source=${localEnv:HOME}/.cache,target=/home/${localEnv:USER}/.cache,type=bind,consistency=cached",
14+
"source=${localEnv:HOME}/.netrc,target=/home/${localEnv:USER}/.netrc,readonly,type=bind,consistency=cached",
15+
"source=${localEnv:HOME}/.bash_history_devcontainer,target=/home/${localEnv:USER}/.bash_history,type=bind,consistency=cached"
16+
],
17+
"forwardPorts": [8888],
18+
"containerEnv": {
19+
"TMPDIR": "/tmp",
20+
"NUMBA_CACHE_DIR": "/tmp/"
21+
},
22+
"build": {
23+
"context": "${localWorkspaceFolder}",
24+
"dockerfile": "${localWorkspaceFolder}/Dockerfile",
25+
"target": "development",
26+
"args": {
27+
// These values will be filled automatically at build time by devcontainer.
28+
"USERNAME": "${localEnv:USER}",
29+
"USER_UID": "${localEnv:USER_UID}",
30+
"USER_GID": "${localEnv:USER_GID}"
31+
}
32+
},
33+
"workspaceMount": "source=${localWorkspaceFolder},target=/workspace/codonfm,type=bind,consistency=cached",
34+
"workspaceFolder": "/workspace/codonfm",
35+
"postCreateCommand": "./.devcontainer/postCreateCommand.sh",
36+
"remoteUser": "${localEnv:USER}",
37+
"updateRemoteUserUID": true,
38+
"initializeCommand": "./.devcontainer/initializeCommand.sh",
39+
"customizations": {
40+
"vscode": {
41+
"extensions": [
42+
"ms-python.python",
43+
"ms-python.vscode-pylance",
44+
"eamodio.gitlens",
45+
"streetsidesoftware.code-spell-checker",
46+
"ms-azuretools.vscode-docker",
47+
"charliermarsh.ruff",
48+
"njpwerner.autodocstring",
49+
"ms-toolsai.jupyter",
50+
"tamasfe.even-better-toml"
51+
]
52+
}
53+
}
54+
}
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#!/bin/bash
2+
# Create the mounted config directories if they don't already exist
3+
4+
mkdir -p ~/.aws
5+
mkdir -p ~/.ngc
6+
mkdir -p ~/.cache
7+
mkdir -p ~/.ssh
8+
[ ! -f ~/.netrc ] && touch ~/.netrc
9+
10+
# Create the ~/.bash_history_devcontainer file if it doesn't exist
11+
[ ! -f ~/.bash_history_devcontainer ] && touch ~/.bash_history_devcontainer
12+
13+
exit 0
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pip install -e .
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Exclude heavy or local-only artifacts from image build context
2+
3+
# Requested exclusions
4+
wandb/
5+
**/wandb/**
6+
checkpoints/
7+
**/checkpoints/**
8+
results/
9+
**/results/**
10+
.env
11+
**/.env/**
12+
Dockerfile
13+
README.md
14+
__pycache__
15+
.dockerignore
16+
17+
./data
18+
./.git
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
extend = "../.ruff.toml"
2+
[lint.extend-per-file-ignores]
3+
"**/*.ipynb" = [
4+
"C411",
5+
"C416",
6+
"C901",
7+
"D101",
8+
"D102",
9+
"E402",
10+
"E722",
11+
"F402",
12+
"FURB187",
13+
"NPY002",
14+
"PERF401",
15+
"PERF402",
16+
"PLW0127",
17+
"PLW2901",
18+
"RUF003",
19+
"RUF005",
20+
"RUF015",
21+
"RUF017",
22+
"RUF059",
23+
"RUF100",
24+
]
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# To build a production image:
2+
# docker build -t <image_name> --target production .
3+
#
4+
# To build a development image:
5+
# docker build -t <image_name> --target development --build-arg USERNAME=$(whoami) --build-arg USER_UID=$(id -u) --build-arg USER_GID=$(id -g) .
6+
7+
ARG FROM_IMAGE_NAME=nvcr.io/nvidia/pytorch:25.08-py3
8+
FROM ${FROM_IMAGE_NAME} AS base
9+
10+
ENV CUDA_HOME=/usr/local/cuda
11+
ENV PATH=$CUDA_HOME/bin:$PATH
12+
ENV LD_LIBRARY_PATH=$CUDA_HOME/lib64:$LD_LIBRARY_PATH
13+
14+
WORKDIR /workspace/codonfm
15+
16+
# Copy requirements first for better layer caching
17+
COPY ./requirements.txt .
18+
19+
# Install dependencies
20+
RUN pip install -r requirements.txt \
21+
&& apt-get update \
22+
&& apt-get install -y libsndfile1 ffmpeg
23+
24+
25+
26+
# ----------------- Production Stage -----------------
27+
FROM base AS production
28+
29+
WORKDIR /workspace/codonfm
30+
COPY . .
31+
# Add a CMD for production if you have a main script to run
32+
# e.g., CMD ["python", "app.py"]
33+
34+
35+
# ----------------- Development Stage -----------------
36+
FROM base AS development
37+
38+
WORKDIR /workspace/codonfm
39+
40+
# Install development specific packages
41+
RUN apt-get update && apt-get install -y htop rsync
42+
43+
# Create a non-root user for development (robust to empty args)
44+
ARG USERNAME
45+
ARG USER_UID
46+
ARG USER_GID
47+
48+
RUN set -eux; \
49+
USERNAME_EFF="${USERNAME:-vscode}"; \
50+
USER_UID_EFF="${USER_UID:-1001}"; \
51+
USER_GID_EFF="${USER_GID:-1001}"; \
52+
if ! getent group "$USER_GID_EFF" >/dev/null 2>&1; then \
53+
groupadd --gid "$USER_GID_EFF" "$USERNAME_EFF"; \
54+
fi; \
55+
if ! id -u "$USERNAME_EFF" >/dev/null 2>&1; then \
56+
useradd -l --uid "$USER_UID_EFF" --gid "$USER_GID_EFF" -m "$USERNAME_EFF"; \
57+
fi # noqa: E702
58+
59+
# Copy source code into the image for development
60+
COPY . .
61+
62+
# Ensure developer owns the app directory
63+
RUN chown -R ${USERNAME:-vscode}:${USERNAME:-vscode} /workspace/codonfm
64+
65+
# Switch to the non-root user
66+
USER $USERNAME
Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and # noqa: E702
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and # noqa: E702
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and # noqa: E702
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or # noqa: E702
114+
documentation, if provided along with the Derivative Works; or, # noqa: E702
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS
178+
179+
APPENDIX: How to apply the Apache License to your work.
180+
181+
To apply the Apache License to your work, attach the following
182+
boilerplate notice, with the fields enclosed by brackets "[]"
183+
replaced with your own identifying information. (Don't include
184+
the brackets!) The text should be enclosed in the appropriate
185+
comment syntax for the file format. We also recommend that a
186+
file or class name and description of purpose be included on the
187+
same "printed page" as the copyright notice for easier
188+
identification within third-party archives.
189+
190+
Copyright 2025 NVIDIA
191+
192+
Licensed under the Apache License, Version 2.0 (the "License"); # noqa: E703
193+
you may not use this file except in compliance with the License.
194+
You may obtain a copy of the License at
195+
196+
http://www.apache.org/licenses/LICENSE-2.0
197+
198+
Unless required by applicable law or agreed to in writing, software
199+
distributed under the License is distributed on an "AS IS" BASIS,
200+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201+
See the License for the specific language governing permissions and
202+
limitations under the License.

0 commit comments

Comments
 (0)