Skip to content

Commit

Permalink
docs: headings update (#186)
Browse files Browse the repository at this point in the history
* docs: headings update

* no bold entries on home page
  • Loading branch information
afgambin authored Nov 8, 2024
1 parent 316acde commit 2a10edc
Show file tree
Hide file tree
Showing 4 changed files with 22 additions and 22 deletions.
20 changes: 10 additions & 10 deletions docs/how-to/dss.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ This guide describes how to manage Data Science Stack (DSS).

DSS is a Command Line Interface (CLI)-based environment and distributed as a `snap`_.

Install DSS
-----------
Install
--------

.. note::
To install DSS, ensure you have previously installed `Snap`_ and `MicroK8s`_.
Expand All @@ -25,8 +25,8 @@ Then, you can run the DSS CLI with:
dss
Start DSS
---------
Initialise
-----------

You can initialise DSS through ``dss initialize``.
This command:
Expand Down Expand Up @@ -60,8 +60,8 @@ You should expect an output like this:
dss create my-notebook --image=pytorch
dss create my-notebook --image=kubeflownotebookswg/jupyter-scipy:v1.8.0
Remove DSS
----------
Remove
-------

You can remove DSS from your MicroK8s cluster through ``dss purge``.
This command purges all the DSS components, including:
Expand Down Expand Up @@ -90,8 +90,8 @@ You should expect an output like this:
Waiting for namespace dss to be deleted...
Success: All DSS components and notebooks purged successfully from the Kubernetes cluster.
Get DSS status
--------------
Get status
-----------

You can check the DSS status through ``dss status``.
This command provides a quick way to check the status of your DSS environment, including the MLflow status and whether a GPU is detected in your environment.
Expand All @@ -108,8 +108,8 @@ If you already have a DSS environment running and no GPU available, the expected
MLflow URL: http://10.152.183.68:5000
GPU acceleration: Disabled
List DSS commands
-----------------
List commands
--------------

You can get the list of available commands for DSS through the ``dss`` command with the ``--help`` option:

Expand Down
14 changes: 7 additions & 7 deletions docs/how-to/mlflow.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ It includes tracking experiments, packaging code into reproducible runs, and sha
Access MLflow
-------------

You can access the MLflow User Interface (UI) within your Data Science Stack (DSS) environment through a web browser,
You can access the MLflow User Interface (UI) within your DSS environment through a web browser,
by navigating to the URL associated with MLflow.
This UI allows you to interact directly with your MLflow experiments and models.

Expand Down Expand Up @@ -42,10 +42,10 @@ For example:
Once you know the URL, open a web browser and enter the URL into the address bar.
This will direct you to the MLflow interface.

Get MLflow logs
---------------
Get logs
---------

You can retrieve logs for MLflow within your Data Science Stack (DSS) environment.
You can retrieve MLflow logs within your DSS environment.
Retrieving logs is a critical task for maintaining and troubleshooting MLflow.

To get MLflow logs, use the ``dss logs`` command with the ``--mlflow`` option:
Expand All @@ -68,11 +68,11 @@ You should expect an output like this:
[2024-04-30 07:57:54 +0000] [26] [INFO] Booting worker with pid: 26
Get MLflow artefacts
--------------------
Get artefacts
--------------

MLflow artefacts, including `models <https://mlflow.org/docs/latest/models.html>`_, `experiments <https://mlflow.org/docs/latest/tracking.html#experiments>`_ and `runs <https://mlflow.org/docs/latest/tracking.html#runs>`_ are stored within your DSS environment.
They can be accessed and downloaded from the :ref:`MLflow UI <access_mlflow>`.
You can access and download them from the :ref:`MLflow UI <access_mlflow>`.

See also
--------
Expand Down
6 changes: 3 additions & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,17 +24,17 @@ In this documentation

.. grid-item:: :doc:`Tutorial <tutorial/index>`

**Get started** - a hands-on introduction to DSS for newcomers
Get started - a hands-on introduction to DSS for newcomers

.. grid-item:: :doc:`How-to guides <how-to/index>`

**Step-by-step guides** covering key operations and common tasks with DSS
Step-by-step guides covering key operations and common tasks with DSS

.. grid:: 1 1 2 2

.. grid-item:: :doc:`Explanation <explanation/index>`

**Discussion and clarification** of key topics
Discussion and clarification of key topics

---------

Expand Down
4 changes: 2 additions & 2 deletions docs/tutorial/get-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ Prerequisites

.. _set_microk8s:

Setting up MicroK8s
-------------------
Set up MicroK8s
---------------

DSS relies on a container orchestration system, capable of exposing the host GPUs to the workloads.
`MicroK8s`_ is used as the orchestration system.
Expand Down

0 comments on commit 2a10edc

Please sign in to comment.