Skip to content

Commit

Permalink
moar docs
Browse files Browse the repository at this point in the history
  • Loading branch information
ankona committed Oct 24, 2024
1 parent 761a8ee commit 00a2762
Show file tree
Hide file tree
Showing 13 changed files with 943 additions and 942 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ sbatch run_hello_world.sh
### Batch Launch Examples

SmartSim can also launch workloads in a batch directly from Python, without the need
for a batch script. Users can launch groups of ``Model`` instances in a ``Ensemble``.
for a batch script. Users can launch groups of ``Application`` instances in a ``Ensemble``.

The following launches 4 replicas of the the same ``hello_world`` model.

Expand Down Expand Up @@ -293,7 +293,7 @@ initialization. Local launching does not support batch workloads.

## Redis + RedisAI

The ``Orchestrator`` is an in-memory database that utilizes Redis and RedisAI to provide
The ``FeatureStore`` is an in-memory database that utilizes Redis and RedisAI to provide
a distributed database and access to ML runtimes from Fortran, C, C++ and Python.

SmartSim provides classes that make it simple to launch the database in many
Expand All @@ -307,7 +307,7 @@ how to use the database to perform ML inference and processing.
The following script launches a single database using the local launcher.

[Experiment.create_database](https://www.craylabs.org/docs/api/smartsim_api.html#smartsim.experiment.Experiment.create_database)
will initialize an ``Orchestrator`` instance corresponding to the specified launcher.
will initialize an ``FeatureStore`` instance corresponding to the specified launcher.

```python
# run_db_local.py
Expand All @@ -329,7 +329,7 @@ exp.stop(db)

### Interactive Launch

The ``Orchestrator``, like ``Ensemble`` instances, can be launched locally, in interactive
The ``FeatureStore``, like ``Ensemble`` instances, can be launched locally, in interactive
allocations, or in a batch.

The following example launches a distributed (3 node) database cluster
Expand Down Expand Up @@ -373,7 +373,7 @@ python run_db.py

### Batch Launch

The ``Orchestrator`` can also be launched in a batch without the need for an interactive allocation.
The ``FeatureStore`` can also be launched in a batch without the need for an interactive allocation.
SmartSim will create the batch file, submit it to the batch system, and then wait for the database
to be launched. Users can hit CTRL-C to cancel the launch if needed.

Expand Down
6 changes: 3 additions & 3 deletions doc/api/smartsim_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Settings

.. currentmodule:: smartsim.settings

Settings are provided to ``Model`` and ``Ensemble`` objects
Settings are provided to ``Application`` and ``Ensemble`` objects
to provide parameters for how a job should be executed. For
more information, see ``LaunchSettings``

Expand Down Expand Up @@ -127,7 +127,7 @@ container.
:undoc-members:
:members:

.. _orc_api:
.. _featurestore_api:

FeatureStore
============
Expand Down Expand Up @@ -170,7 +170,7 @@ FeatureStore
:inherited-members:
:undoc-members:

.. _model_api:
.. _application_api:

Application
===========
Expand Down
8 changes: 4 additions & 4 deletions doc/batch_settings.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Batch Settings
========
Overview
========
SmartSim provides functionality to launch entities (``Model`` or ``Ensemble``)
SmartSim provides functionality to launch entities (``Application`` or ``Ensemble``)
as batch jobs supported by the ``BatchSettings`` base class. While the ``BatchSettings`` base
class is not intended for direct use by users, its derived child classes offer batch
launching capabilities tailored for specific workload managers (WLMs). Each SmartSim
Expand Down Expand Up @@ -61,7 +61,7 @@ Below are examples of how to initialize a ``BatchSettings`` object per `launcher
sbatch_settings.set_queue("default")
The initialized ``SbatchSettings`` instance can now be passed to a SmartSim entity
(``Model`` or ``Ensemble``) via the `batch_settings` argument in ``create_batch_settings``.
(``Application`` or ``Ensemble``) via the `batch_settings` argument in ``create_batch_settings``.

.. note::
If `launcher="auto"`, SmartSim will detect that the ``Experiment`` is running on a Slurm based
Expand All @@ -87,7 +87,7 @@ Below are examples of how to initialize a ``BatchSettings`` object per `launcher
qsub_batch_settings.set_queue("default")
The initialized ``QsubBatchSettings`` instance can now be passed to a SmartSim entity
(``Model`` or ``Ensemble``) via the `batch_settings` argument in ``create_batch_settings``.
(``Application`` or ``Ensemble``) via the `batch_settings` argument in ``create_batch_settings``.

.. note::
If `launcher="auto"`, SmartSim will detect that the ``Experiment`` is running on a PBS Pro based
Expand All @@ -113,7 +113,7 @@ Below are examples of how to initialize a ``BatchSettings`` object per `launcher
bsub_batch_settings.set_queue("default")
The initialized ``BsubBatchSettings`` instance can now be passed to a SmartSim entity
(``Model`` or ``Ensemble``) via the `batch_settings` argument in ``create_batch_settings``.
(``Application`` or ``Ensemble``) via the `batch_settings` argument in ``create_batch_settings``.

.. note::
If `launcher="auto"`, SmartSim will detect that the ``Experiment`` is running on a LSF based
Expand Down
1 change: 1 addition & 0 deletions doc/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ Jump to:

Description

- Update documentation to build under v1.0 API
- Merge core refactor into MLI feature branch
- Implement asynchronous notifications for shared data
- Quick bug fix in _validate
Expand Down
6 changes: 3 additions & 3 deletions doc/dragon.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ After installation, specify Dragon as the launcher when creating an ``Experiment
exp = Experiment(name="dragon-example", launcher="dragon")
Dragon introduces its own run settings class, ``DragonRunSettings``, which allows users to
specify nodes and tasks per node for a ``Model``. For instance, continuing from the previous
specify nodes and tasks per node for a ``Application``. For instance, continuing from the previous
example:

.. code-block:: python
Expand All @@ -60,7 +60,7 @@ example:
# Start the Model
exp.start(mpi_app)
SmartSim supports ``DragonRunSettings`` with ``Model``, ``Ensemble`` and ``Orchestrator`` entities.
SmartSim supports ``DragonRunSettings`` with ``Application``, ``Ensemble`` and ``FeatureStore`` entities.
In the next sections, we detail how Dragon is integrated into SmartSim.

For more information on HPC launchers, visit the :ref:`Run Settings<run_settings_hpc_ex>` page.
Expand Down Expand Up @@ -98,7 +98,7 @@ The Dragon Server
=================

Dragon can initiate processes on any available resource within an allocation. To facilitate
this, SmartSim initializes the Dragon infrastructure whenever a ``Model`` is launched and maintains
this, SmartSim initializes the Dragon infrastructure whenever a ``Application`` is launched and maintains
it until the parent ``Experiment`` concludes. To facilitate interaction with processes managed by
Dragon, SmartSim establishes a command server within the Dragon infrastructure. This server,
known as the `Dragon Server`, is responsible for executing commands to start or stop processes
Expand Down
Loading

0 comments on commit 00a2762

Please sign in to comment.