You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
RUN uv pip install "recommonmark==0.7.1""sphinx==5.1.1""sphinx-rtd-theme==1.0.0""pydocstyle==6.1.1""nbsphinx==0.8.9""nbconvert==6.4.3""jinja2==3.0.3"
287
+
RUN uv pip install "recommonmark>=0.7.1""sphinx>=5.1.1""nvidia-sphinx-theme>=0.0.7""pydocstyle>=6.1.1""nbsphinx>=0.8.9""nbconvert>=6.4.3""jinja2>=3.0.3"
306
288
RUN wget https://github.com/jgm/pandoc/releases/download/3.1.6.2/pandoc-3.1.6.2-1-amd64.deb && dpkg -i pandoc-3.1.6.2-1-amd64.deb
Copy file name to clipboardExpand all lines: README.md
+25-16Lines changed: 25 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -65,7 +65,7 @@ provides built-in composable modules that are packaged into a few key components
65
65
<!-- markdownlint-disable -->
66
66
Component | Description |
67
67
---- | --- |
68
-
[**physicsnemo.models**](https://docs.nvidia.com/deeplearning/physicsnemo/physicsnemo-core/api/physicsnemo.models.html) | A collection of optimized, customizable, and easy-to-use families of model architectures such as Neural Operators, Graph Neural Networks, Diffusion models, Transformer models, and many more|
68
+
[**physicsnemo.models**](https://docs.nvidia.com/physicsnemo/latest/user-guide/model_architectures.html) ( [More Details](https://docs.nvidia.com/physicsnemo/latest/physicsnemo/api_models.html)) | A collection of optimized, customizable, and easy-to-use families of model architectures such as Neural Operators, Graph Neural Networks, Diffusion models, Transformer models, and many more|
69
69
[**physicsnemo.datapipes**](https://docs.nvidia.com/deeplearning/physicsnemo/physicsnemo-core/api/physicsnemo.datapipes.html) | Optimized and scalable built-in data pipelines fine-tuned to handle engineering and scientific data structures like point clouds, meshes, etc.|
70
70
[**physicsnemo.distributed**](https://docs.nvidia.com/deeplearning/physicsnemo/physicsnemo-core/api/physicsnemo.distributed.html) | A distributed computing sub-module built on top of `torch.distributed` to enable parallel training with just a few steps|
71
71
[**physicsnemo.curator**](https://github.com/NVIDIA/physicsnemo-curator) | A sub-module to streamline and accelerate the process of data curation for engineering datasets|
@@ -119,7 +119,7 @@ PhysicsNeMo offers a library of state-of-the-art models specifically designed
119
119
for Physics-ML applications. Users can build any model architecture by using the underlying
120
120
PyTorch layers and combining them with curated PhysicsNeMo layers.
121
121
122
-
The [Model Zoo](https://docs.nvidia.com/deeplearning/physicsnemo/physicsnemo-core/api/physicsnemo.models.html#model-zoo)
122
+
The [Model Zoo](https://docs.nvidia.com/physicsnemo/latest/user-guide/model_architectures.html)
123
123
includes optimized implementations of families of model architectures such as
124
124
Neural Operators:
125
125
@@ -333,16 +333,14 @@ way is to start with a reference sample and then update it for your own use case
333
333
334
334
## Installation
335
335
336
-
The following instructions help you install the base PhysicsNeMo modules to get
337
-
started. In addition to this, optional dependencies can be installed to provide
338
-
additional functionality. A complete list of optional dependencies is available
339
-
in the [`pyproject.toml`](./pyproject.toml) file.
336
+
You can install PhysicsNeMo in two supported ways: **via pip** (native pip or
337
+
**uv**) or by using the **NVIDIA container image**. Choose the method that fits your
338
+
environment and workflow.
340
339
341
-
The [training recipes](./examples) are not packaged into the pip wheels or the
342
-
container to keep the footprint low. We recommend users clone the appropriate
343
-
training recipes and use them as a starting point. These training recipes may
344
-
require additional example-specific dependencies, as indicated through an
345
-
associated `requirements.txt` file in such cases.
340
+
The following instructions cover the base PhysicsNeMo modules. Optional dependencies
341
+
are listed in [`pyproject.toml`](./pyproject.toml). The [training recipes](./examples)
342
+
are not bundled in the pip wheels or container; clone the repo and use the examples
343
+
as a starting point. Many examples have a `requirements.txt` for extra dependencies.
346
344
347
345
### CUDA Backend Selection
348
346
@@ -363,7 +361,7 @@ via an extra that is orthogonal to the feature extras - combine them freely:
363
361
364
362
### PyPI
365
363
366
-
The recommended method for installing the latest version of PhysicsNeMo is using PyPI:
364
+
Install the latest version from PyPI:
367
365
368
366
```Bash
369
367
pip install nvidia-physicsnemo
@@ -387,7 +385,7 @@ The installation can also be verified by running the [Hello World](#hello-world)
387
385
388
386
### uv
389
387
390
-
For development or to run examples, we recommend using[uv](https://docs.astral.sh/uv/)
388
+
For development or to run examples from source, you can use[uv](https://docs.astral.sh/uv/)
0 commit comments