Skip to content

Commit 6fef8ec

Browse files
committed
Add documentation describing how to make your configuration
1 parent 57e92be commit 6fef8ec

File tree

2 files changed

+50
-0
lines changed

2 files changed

+50
-0
lines changed
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. _install-notes:
2+
3+
General Installation Notes
4+
==========================
5+
6+
SmartSim has been installed on a variety of systems and our users often have
7+
different build environments and toolchains. The following two sections detail
8+
some common situations and how to setup and modify your build environment:
9+
10+
.. include:: install_notes/generic.rst
11+
12+
.. include:: install_notes/nonroot-linux.rst
13+
14+
.. include:: install_notes/offline.rst
15+
16+
.. include:: install_notes/custom_backends.rst
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
Custom ML backends
2+
------------------
3+
4+
The ML backends (Torch, ONNX Runtime, and Tensorflow) and their associated
5+
python packages have different versions and indices that can be supported based
6+
on the intended device (CPU, ROCM, CUDA-11, or CUDA-12). SmartSim stores this
7+
information in JSON files within the ``smartsim/_core/_install/configs/mlpackages``
8+
directory. If a different version or variant is needed, these can be specified
9+
using ``smart build --config-dir <path-to-config-dir>``. The following is the
10+
JSON file used for Linux with CUDA-12.
11+
12+
.. literalinclude:: ../../../smartsim/_core/_install/configs/mlpackages/Linux64CUDA12.json
13+
14+
The following table explains what each of the main fields are:
15+
16+
.. list-table:: MLPackages fields
17+
:widths: 25 50
18+
:header-rows: 1
19+
20+
* - Field Name
21+
- Description
22+
* - name
23+
- The name of the C++ frontend to the ML package itself (e.g. libtorch)
24+
* - version
25+
- A string used to identify the version of the library. Note that this does not have
26+
an effect on the build process itself, but is used to display information
27+
* - pip_index
28+
- The pip index from which to install the python packages associated with this ML package
29+
* - lib_source
30+
- The location of the archive which contains the ML backend. If this is a URL, the file
31+
will be downloaded, otherwise if this is a local path, the archive will be copied to
32+
the build library and extracted
33+
* - rai_patches
34+
- Patch RedisAI source code with modifications needed by this ML package

0 commit comments

Comments
 (0)