GGitHubDocumentation (#36)
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
Documentation (#36) * Add and restructure documentation for RFdiffusion2 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. * Add sphinx-new-tab-link and update documentation overview 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. * Update and expand documentation for RFdiffusion2 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. * Add CUDA 12.1/12.4 environment setup files 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. * Update documentation for ORI tokens and config options Replaces ori_tokens.md with a new ori_tokens.rst containing detailed instructions and images. Updates configuration_options.md with more guidance on custom configs. Adjusts Sphinx conf.py exclude patterns and comments, updates index.rst to use the new ORI tokens doc, and adds supporting images. Minor typo fix in overview.md and clarifying comments in example usage docs. * Update doc/source/usage/ori_tokens.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update doc/source/conf.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> | 9 个月前 | |
Documentation (#36) * Add and restructure documentation for RFdiffusion2 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. * Add sphinx-new-tab-link and update documentation overview 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. * Update and expand documentation for RFdiffusion2 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. * Add CUDA 12.1/12.4 environment setup files 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. * Update documentation for ORI tokens and config options Replaces ori_tokens.md with a new ori_tokens.rst containing detailed instructions and images. Updates configuration_options.md with more guidance on custom configs. Adjusts Sphinx conf.py exclude patterns and comments, updates index.rst to use the new ORI tokens doc, and adds supporting images. Minor typo fix in overview.md and clarifying comments in example usage docs. * Update doc/source/usage/ori_tokens.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update doc/source/conf.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> | 9 个月前 | |
Documentation (#36) * Add and restructure documentation for RFdiffusion2 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. * Add sphinx-new-tab-link and update documentation overview 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. * Update and expand documentation for RFdiffusion2 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. * Add CUDA 12.1/12.4 environment setup files 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. * Update documentation for ORI tokens and config options Replaces ori_tokens.md with a new ori_tokens.rst containing detailed instructions and images. Updates configuration_options.md with more guidance on custom configs. Adjusts Sphinx conf.py exclude patterns and comments, updates index.rst to use the new ORI tokens doc, and adds supporting images. Minor typo fix in overview.md and clarifying comments in example usage docs. * Update doc/source/usage/ori_tokens.rst Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update doc/source/conf.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> | 9 个月前 | |
Updated installation instructions (#32) * Add and restructure documentation for RFdiffusion2 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. * Add sphinx-new-tab-link and update documentation overview 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. * Update and expand documentation for RFdiffusion2 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. * Add CUDA 12.1/12.4 environment setup files 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. * Update envs/requirements_cuda121.txt Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update envs/cuda124_env.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update envs/cuda121_env.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update doc/source/installation.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update doc/source/installation.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update doc/source/conf.py Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Fix formatting and spelling in README.md * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> | 10 个月前 |