Updated installation instructions #32
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Introduces new documentation files including installation instructions, overview, and links to README and license. Updates Sphinx configuration to include sphinx-copybutton and reorganizes index.rst for improved navigation. The GitHub workflow now installs sphinx-copybutton. README updated with a link to the documentation site.
Added the sphinx-new-tab-link extension to the Sphinx build process and configuration. Updated overview.md with a detailed explanation of RFdiffusion2's capabilities and differences from the original RFdiffusion, and excluded overview.md from Sphinx build patterns.
Improved the README with clearer setup, installation, and inference instructions, and added troubleshooting tips. Expanded the documentation by adding new usage examples, configuration options, and ORI token explanations. Updated Sphinx configuration and index to include new documentation files, and adjusted workflow and dependencies to comment out unused Sphinx extensions. Enhanced installation guide with troubleshooting for Apptainer image issues and clarified instructions for both Apptainer and source installations.
Introduced conda environment YAMLs and pip requirements for CUDA 12.1 and 12.4 support in the 'envs' directory. Updated installation documentation to guide users on using these files and troubleshooting environment setup. Minor README correction for pipeline argument.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR updates the installation documentation and adds environment configuration files to simplify RFdiffusion2 setup. The key changes include adding submitit as a required dependency (needed for the pipeline.py workflow), creating pre-configured conda environment files for different CUDA versions, and expanding the installation guide with troubleshooting information and alternative setup methods.
- Added conda environment files and pip requirements files for CUDA 12.1 and 12.4
- Updated installation documentation with new troubleshooting sections and environment setup options
- Added
submititto dependency lists and installation instructions
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| envs/requirements_cuda124.txt | New pip requirements file for CUDA 12.4 installations including submitit |
| envs/requirements_cuda121.txt | New pip requirements file for CUDA 12.1 installations including submitit |
| envs/cuda124_env.yml | New conda environment file for CUDA 12.4 setup |
| envs/cuda121_env.yml | New conda environment file for CUDA 12.1 setup |
| doc/source/installation.md | Expanded installation guide with new sections for environment files, troubleshooting, and manual setup |
| doc/source/index.rst | Added new usage documentation pages to table of contents |
| doc/source/conf.py | Removed unused extension and updated exclude patterns |
| doc/source/overview.md | Removed italics formatting from paper title link |
| README.md | Enhanced setup instructions, viewing designs section, and general documentation improvements |
| doc/source/usage/*.md | New placeholder files for usage documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
Copilot reviewed 14 out of 14 changed files in this pull request and generated 3 comments.
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Updated the installation instructions to also include installing submitit, which is necessary to run the full workflow in
pipeline.py. Created environment (to use with conda) and requirement (to use with pip) files to potentially make installation of RFdiffusion2 easier.