Skip to content

Commit

Permalink
docs: Update docs to pass linter (#8705)
Browse files Browse the repository at this point in the history
  • Loading branch information
sirredbeard authored Jan 17, 2024
1 parent 00c2746 commit 4aedded
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
10 changes: 4 additions & 6 deletions docs/setup-cluster/on-prem/options/wsl.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ master and agent running on the same machine within WSL.
- WSL 2 `installed and enabled <https://learn.microsoft.com/en-us/windows/wsl/install>`_ on your
Windows machine.

- An Ubuntu or an Enterprise Linux WSL distribution installed from the Microsoft Store,
such as:
- An Ubuntu or an Enterprise Linux WSL distribution installed from the Microsoft Store, such as:

- `Ubuntu 22.04 LTS <https://www.microsoft.com/store/productId/9PDXGNCFSCZV>`_
- `AlmaLinux 9 <https://www.microsoft.com/store/productId/9P5RWLM70SN9>`_
Expand Down Expand Up @@ -67,7 +66,7 @@ Edit the configuration file to enable ``systemd`` within your WSL distribution.
#########################################

This user guide provides instructions for using the ``det deploy`` command-line tool to deploy
Determined locally on WSL. ``det deploy`` automates the process of starting Determined as a
Determined locally on WSL. ``det deploy`` automates the process of starting Determined as a
collection of Docker containers.

You can also use ``det deploy`` to install Determined on the cloud. For more information, see the
Expand Down Expand Up @@ -137,8 +136,7 @@ master and an agent on the same node. To do this, run one of the following comma
det deploy local cluster-up --no-gpu
This will start a master and an agent on that machine. To verify that the master is running,
navigate to ``http://localhost:8080`` in a browser, which should bring up the Determined
WebUI.
navigate to ``http://localhost:8080`` in a browser, which should bring up the Determined WebUI.

To open the WebUI from WSL:

Expand Down Expand Up @@ -186,4 +184,4 @@ To stop a Determined cluster, on the machine where a Determined cluster is curre
.. note::

``det deploy local cluster-down`` will not remove any agents created with ``det deploy local
agent-up``. To remove these agents, use ``det deploy local agent-down``.
agent-up``. To remove these agents, use ``det deploy local agent-down``.
4 changes: 2 additions & 2 deletions docs/setup-cluster/on-prem/requirements.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A Determined cluster has the following requirements.
Software
========

- The Determined agent and master nodes must be configured with Ubuntu 20.04 or later, Enterprise
- The Determined agent and master nodes must be configured with Ubuntu 20.04 or later, Enterprise
Linux 7 (such as AlmaLinux, Red Hat Enterprise Linux, or Rocky Linux), or macOS 10.13 or later.

- The agent nodes must have :ref:`Docker installed <install-docker>`.
Expand Down Expand Up @@ -144,7 +144,7 @@ Install on macOS
Docker on macOS does not support containers that use GPUs. Because of this, macOS Determined agents
are only able to run CPU-based workloads.

.. _install-docker-on-WSL:
.. _install-docker-on-wsl:

Install on Windows Subsystem for Linux (WSL)
============================================
Expand Down
16 changes: 9 additions & 7 deletions docs/tutorials/quickstart-mdldev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,18 @@ Software

- Determined *agent* and *master* nodes must be configured with the following operating systems:

- Ubuntu 20.04 or later
- Enterprise Linux (e.g., AlmaLinux, Oracle Linux, Red Hat Enterprise Linux, or Rocky Linux) 7 or higher
- Windows Subsystem for Linux (WSL) 2 on Windows 10 version 1903 or higher, with a supported Linux distribution
installed
- macOS 10.13 or later
- Ubuntu 20.04 or later
- Enterprise Linux (e.g., AlmaLinux, Oracle Linux, Red Hat Enterprise Linux, or Rocky Linux) 7
or higher
- Windows Subsystem for Linux (WSL) 2 on Windows 10 version 1903 or higher, with a supported
Linux distribution installed
- macOS 10.13 or later

- Agent nodes must have Docker installed.

- To run jobs that use GPUs, you need NVIDIA drivers with a version of 384.81 or later installed on each agent.
These drivers can be installed independently, but you don't need to install the entire CUDA toolkit.
- To run jobs that use GPUs, you need NVIDIA drivers with a version of 384.81 or later installed on
each agent. These drivers can be installed independently, but you don't need to install the
entire CUDA toolkit.

Hardware
========
Expand Down

0 comments on commit 4aedded

Please sign in to comment.