diff --git a/docs/source/primaite_session.rst b/docs/source/primaite_session.rst index a0b53c7d..f3ef0399 100644 --- a/docs/source/primaite_session.rst +++ b/docs/source/primaite_session.rst @@ -19,7 +19,7 @@ module directly without running a session. Run --- -A PrimAITE session can started either with the ``primaite session`` command from the cli +A PrimAITE session can be started either with the ``primaite session`` command from the cli (See :func:`primaite.cli.session`), or by calling :func:`primaite.main.run` from a Python terminal or Jupyter Notebook. There are two parameters that can be specified: @@ -29,6 +29,6 @@ There are two parameters that can be specified: Outputs ------- -Running a session creates a session outputs directory in your user data foler. The format looks like this: -``~/primaite/3.0.0/sessions/YYYY-MM-DD/HH-MM-SS/``. This folders contains simulation sys logs generated by each node, -and the saved agent checkpoints, and final model. +Running a session creates a session output directory in your user data folder. The filepath looks like this: +``~/primaite/3.0.0/sessions/YYYY-MM-DD/HH-MM-SS/``. This folder contains the simulation sys logs generated by each node, +the saved agent checkpoints, and final model.