[Feature Request] Documentation for multiple backends #3121
Labels
Milestone
Comments
7 tasks
wanghan-iapcm
pushed a commit
that referenced
this issue
Jan 24, 2024
Fix #3121. The PyTorch icon can be added when a feature implemented by PyTorch is added. However, I can't find a way to add an icon to TOC.  Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
iProzd
added a commit
to iProzd/deepmd-kit
that referenced
this issue
Jan 24, 2024
* Fix max nbor size related issues (deepmodeling#3157) * Merge master into devel (deepmodeling#3167) * [pre-commit.ci] pre-commit autoupdate (deepmodeling#3163) <!--pre-commit.ci start--> updates: - [github.com/astral-sh/ruff-pre-commit: v0.1.13 → v0.1.14](astral-sh/ruff-pre-commit@v0.1.13...v0.1.14) <!--pre-commit.ci end--> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> * setup PyTorch C++ interface build environement (deepmodeling#3169) See deepmodeling#3120. - CMake: add `ENABLE_TENSORFLOW` and `ENABLE_PYTORCH`. `BUILD_TENSORFLOW` will be enabled when `TENSORFLOW_ROOT` is not empty or `USE_TF_PYTHON_LIBS` is on. - api_cc: add `BUILD_TENSORFLOW` and `BUILD_PYTORCH` defination. Move several functions from `common.h` to `commonTF.h` to prevent exposing them to header files. - CI: download libtorch in the build/test CC actions. --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> * docs: add TF icons to platform-specific features (deepmodeling#3171) Fix deepmodeling#3121. The PyTorch icon can be added when a feature implemented by PyTorch is added. However, I can't find a way to add an icon to TOC.  Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> * add universal Python inference interface DeepPot (deepmodeling#3164) Need discussion for other classes. --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> * detect version in advance before building deepmd-kit-cu11 (deepmodeling#3172) Fix deepmodeling#3168. See: pypa/setuptools-scm#1006 (comment) --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> Co-authored-by: Denghui Lu <denghuilu@pku.edu.cn> Co-authored-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
njzjz
added a commit
to njzjz/deepmd-kit
that referenced
this issue
Jan 28, 2024
Fix deepmodeling#3121. There are TODOs: (1) PyTorch-backend specific features and arguments; (2) Python interface installation. Currently TensorFlow backend is always installed, and I am considering rewrite the logic; (3) Unsupported features - write docs when implemented. Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
wanghan-iapcm
pushed a commit
that referenced
this issue
Jan 29, 2024
Fix #3121. There are TODOs: (1) PyTorch-backend specific features and arguments; (2) Python interface installation. Currently, the TensorFlow backend is always installed, and I am considering rewriting the logic; (3) Unsupported features - write docs when implemented. --------- Signed-off-by: Jinzhe Zeng <jinzhe.zeng@rutgers.edu>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Summary
Propose a way to document multiple backends.
Detailed Description
We may use font-awesome icons like cibuildwheel:
Readers can quickly know which backend is supported.
If commands are different on different backends, Sphinx provides a way:
The problem is that TF and PT icons are unavailable in font-awesome, per FortAwesome/Font-Awesome#17377. We need to make them by ourselves...
Further Information, Files, and Links
No response
The text was updated successfully, but these errors were encountered: