Thank you for your interest in contributing to NGC_OCN! This document provides guidelines and instructions for contributing to the project. At this time, only RAPIDS team members can contribute to RAPIDS Event Notebooks. If you are not a RAPIDS team member, yet have contributed/need to make changes to a presentation, please open an issue and we will reach out.
- Code of Conduct
- Ways to Contribute
- Development Setup
- Coding Standards
- Testing
- Submitting Changes
- Issue Reporting
- Getting Help
We are committed to providing a welcoming and inclusive environment for all allowed contributors. Please be respectful and professional in all interactions.
There are many ways to contribute to NGC_OCN:
- Report bugs: If you find a bug, please open an issue with detailed information
- Suggest enhancements: Have an idea for a new feature? Let us know!
- Improve documentation: Help us make the docs clearer and more comprehensive
- Submit code: Fix bugs, implement features, or improve performance
- Share examples: Contribute notebooks, examples, or use cases
- Python 3.11 or higher
- CUDA-capable GPU (for GPU-accelerated features)
- NVIDIA PyTorch container or equivalent CUDA environment
For a consistent development environment with all GPU dependencies, please install the latest RAPIDS NGC Notebooks container release, found in the release selector , :
docker run --gpus all --pull always --rm -it \
--shm-size=1g --ulimit memlock=-1 --ulimit stack=67108864 \
-p 8888:8888 -p 8787:8787 -p 8786:8786 \
nvcr.io/nvidia/rapidsai/notebooks:26.06-cuda13-py3.14
curl -LsSf https://astral.sh/uv/install.sh | sh
uv sync --extra dev
uv run pre-commit install
git clone https://github.com/your-username/NGC_OCN.git
cd NGC_OCN-
Fork and Clone the Repository
git clone https://github.com/your-username/NGC_OCN.git cd NGC_OCN -
Install uv (if not already installed)
curl -LsSf https://astral.sh/uv/install.sh | sh `
-
Install Development Dependencies
uv sync --extra dev
This automatically creates a virtual environment and installs the project in editable mode along with development tools like
black,isort,flake8, andpre-commit. -
Set Up Pre-commit Hooks
uv run pre-commit install
This will automatically run code formatting and linting checks before each commit.
We follow PEP 8 with the following specifications:
- Line length: 88 characters (Black default)
- String quotes: Use double quotes for strings
- Import ordering: Managed by
isortwith Black profile
All code must be formatted with:
- Black: For consistent code formatting
- isort: For import statement ordering
Run formatters before committing:
uv run black .
uv run isort .Or let pre-commit hooks handle it automatically.
We use flake8 for linting. Run it with:
uv run flake8 src/- Docstrings: Use Google-style docstrings for all public functions, classes, and modules
- Type hints: Include type hints for function parameters and return values
- Comments: Write clear comments explaining complex logic
Example:
def optimize_portfolio(
returns: np.ndarray,
risk_measure: str = "cvar",
confidence_level: float = 0.95
) -> dict:
"""
Optimize portfolio allocation using specified risk measure.
Args:
returns: Historical returns data as numpy array
risk_measure: Risk measure to use ('cvar' or 'variance')
confidence_level: Confidence level for CVaR calculation
Returns:
Dictionary containing optimal weights and performance metrics
Raises:
ValueError: If risk_measure is not supported
"""
# Implementation
passPlease run all notebooks to ensure that both the code, cell outputs, and written instructions are correct before submitting a PR
Use descriptive branch names following this pattern:
feature/description- for new featuresbugfix/description- for bug fixesdocs/description- for documentation updatesrefactor/description- for code refactoring
Write clear, concise commit messages:
Short summary (50 chars or less)
More detailed explanation if needed. Wrap at 72 characters.
Explain what changes were made and why.
- Bullet points are okay
- Use present tense ("Add feature" not "Added feature")
- Reference issues: "Fixes #123" or "Relates to #456"
-
Update your fork with the latest changes from main:
git fetch upstream git rebase upstream/main
-
Run all checks before submitting:
uv run black . uv run isort . uv run flake8 src/ uv run pytest
-
Create a Pull Request with:
- Clear title describing the change
- Detailed description of what and why
- Link to related issues
- Screenshots or examples if applicable
-
Address review feedback promptly and professionally
-
Ensure CI passes - all automated checks must pass
Before submitting, ensure:
- Code follows style guidelines (Black, isort, flake8)
- All tests pass
- New tests added for new features
- Documentation updated (docstrings, README, etc.)
- Commit messages are clear and descriptive
- No merge conflicts with main branch
- Pre-commit hooks pass
When reporting bugs, please include:
- Description: Clear description of the bug
- Steps to reproduce: Exact steps to reproduce the issue
- Expected behavior: What should happen
- Actual behavior: What actually happens
- Environment: OS, Python version, CUDA version, GPU model
- Code snippet: Minimal reproducible example
- Error messages: Full error traceback
Use this template:
**Bug Description**
A clear description of the bug.
**To Reproduce**
1. Step one
2. Step two
3. ...
**Expected Behavior**
What you expected to happen.
**Actual Behavior**
What actually happened.
**Environment**
- OS: [e.g., Ubuntu 22.04]
- Python: [e.g., 3.11]
- CUDA: [e.g., 12.2]
- GPU: [e.g., A100]
- NGC_OCN version: [e.g., 25.10]
**Additional Context**
Any other relevant information.When suggesting features:
- Describe the problem it solves
- Explain the proposed solution
- Consider alternative approaches
- Note any breaking changes
- Issues: Open an issue for bugs or questions
- Discussions: Use GitHub Discussions for general questions
- Documentation: Check the README and module-specific docs
-
We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.
- Any contribution which contains commits that are not Signed-Off will not be accepted.
-
To sign off on a commit you simply use the
--signoff(or-s) option when committing your changes:$ git commit -s -m "Add cool feature."This will append the following to your commit message:
Signed-off-by: Your Name <your@email.com> -
Full text of the DCO (https://developercertificate.org/):
Developer Certificate of Origin Version 1.1 Copyright (C) 2004, 2006 The Linux Foundation and its contributors. Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Developer's Certificate of Origin 1.1 By making a contribution to this project, I certify that: (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it. (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.