From e5f3ca3ce9508d4eb7cea88ab40b72dba652984c Mon Sep 17 00:00:00 2001 From: giulero Date: Thu, 27 Jun 2024 17:10:47 +0200 Subject: [PATCH] Add additional notes --- README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 0de706c0..4ec1916c 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ Other requisites are: - `casadi` - `pytorch` - `numpy` +- `jax2torch` They will be installed in the installation step! @@ -116,6 +117,9 @@ mamba create -n adamenv -c conda-forge adam-robotics If you want to use `jax` or `pytorch`, just install the corresponding package as well. +> [!NOTE] +> Check also the conda JAX installation guide [here](https://jax.readthedocs.io/en/latest/installation.html#conda-community-supported) + ### 🔨 Installation from repo Install in a conda environment the required dependencies: @@ -135,13 +139,13 @@ Install in a conda environment the required dependencies: - **PyTorch** interface dependencies: ```bash - mamba create -n adamenv -c conda-forge pytorch numpy lxml prettytable matplotlib urdfdom-py + mamba create -n adamenv -c conda-forge pytorch numpy lxml prettytable matplotlib urdfdom-py jax2torch ``` - **ALL** interfaces dependencies: ```bash - mamba create -n adamenv -c conda-forge jax casadi pytorch numpy lxml prettytable matplotlib urdfdom-py + mamba create -n adamenv -c conda-forge jax casadi pytorch numpy lxml prettytable matplotlib urdfdom-py jax2torch ``` Activate the environment, clone the repo and install the library: @@ -156,10 +160,13 @@ pip install --no-deps . ## 🚀 Usage The following are small snippets of the use of **adam**. More examples are arriving! -Have also a look at te `tests` folder. +Have also a look at the `tests` folder. ### Jax interface +> [!NOTE] +> Check also the Jax installation guide [here](https://jax.readthedocs.io/en/latest/installation.html#) + ```python import adam from adam.jax import KinDynComputations