Skip to content

Commit

Permalink
Light docs cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
rmkraus committed Jul 2, 2024
1 parent bd71c95 commit 4477e66
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 53 deletions.
41 changes: 10 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,47 +101,28 @@ While this is not a requirement, running this demo without AI Workbench
will require manual work as the pre-configured automation and
integrations may not be available.

<details>
<summary>
<b>Expand this section for setup instructions.</b>
</summary>

### Overview

Typicaly, there are two different styles of developing with AI
Workbench. The first, and most simple is local only development. This is
usually the starting point and AI Workbench allows for native scaling
later. However, this style currently only supports Ubuntu.

``` mermaid
flowchart LR
local
```

The second development style is using a remote lab machine for
development and a thin-client for remotely accessing the development
machine. This allows for compute resources to stay centrally located and
for developers to be more portable. Note, the remote lab machine must
run Ubuntu, but the local client can run Windows, MacOS, or Ubuntu.
This quick start guide will assume a remote lab machine is being used
for development and the local machine is a thin-client for remotely
accessing the development machine. This allows for compute resources to
stay centrally located and for developers to be more portable. Note, the
remote lab machine must run Ubuntu, but the local client can run
Windows, MacOS, or Ubuntu. To install this project local only, simply
skip the remote install.

``` mermaid
flowchart LR
local
subgraph lab environment
remote-machine
remote-lab-machine
end
local <-.ssh.-> remote-machine
local <-.ssh.-> remote-lab-machine
```

For this quick start guide, it is assumed that a remote lab environment
is used. If the first development style is preferred, simply skip the
remote installation steps and note the Ubuntu requirement for local
development.

### Client Machine Install

Ubuntu is required if the local client will also be used for developent.
When using a remote lab machine, this can be Windows, MacOS, or Ubuntu.

<details>
<summary>
Expand Down Expand Up @@ -337,8 +318,6 @@ run these steps as `root`.

</details>

</details>

## Download this project

There are two ways to download this project for local use: Cloning and
Expand Down
23 changes: 4 additions & 19 deletions docs/0_2_0_install_nvwb.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,18 @@

This project is designed to be used with [NVIDIA AI Workbench](https://www.nvidia.com/en-us/deep-learning-ai/solutions/data-science/workbench/). While this is not a requirement, running this demo without AI Workbench will require manual work as the pre-configured automation and integrations may not be available.

<details>
<summary>
<b>Expand this section for setup instructions.</b>
</summary>

### Overview

Typicaly, there are two different styles of developing with AI Workbench. The first, and most simple is local only development. This is usually the starting point and AI Workbench allows for native scaling later. However, this style currently only supports Ubuntu.

```mermaid
flowchart LR
local
```
The second development style is using a remote lab machine for development and a thin-client for remotely accessing the development machine. This allows for compute resources to stay centrally located and for developers to be more portable. Note, the remote lab machine must run Ubuntu, but the local client can run Windows, MacOS, or Ubuntu.
This quick start guide will assume a remote lab machine is being used for development and the local machine is a thin-client for remotely accessing the development machine. This allows for compute resources to stay centrally located and for developers to be more portable. Note, the remote lab machine must run Ubuntu, but the local client can run Windows, MacOS, or Ubuntu. To install this project local only, simply skip the remote install.

```mermaid
flowchart LR
local
subgraph lab environment
remote-machine
remote-lab-machine
end
local <-.ssh.-> remote-machine
local <-.ssh.-> remote-lab-machine
```

For this quick start guide, it is assumed that a remote lab environment is used. If the first development style is preferred, simply skip the remote installation steps and note the Ubuntu requirement for local development.

### Client Machine Install

Ubuntu is required if the local client will also be used for developent.
Ubuntu is required if the local client will also be used for developent. When using a remote lab machine, this can be Windows, MacOS, or Ubuntu.
2 changes: 0 additions & 2 deletions docs/0_2_999_footer.md
Original file line number Diff line number Diff line change
@@ -1,2 +0,0 @@

</details>
1 change: 0 additions & 1 deletion docs/_TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
0_2_2_macos.md
0_2_3_ubuntu.md
0_2_4_remote_ubuntu.md
0_2_999_footer.md
0_3_download.md
0_4_start.md
0_5_knowledgebase.md
Expand Down

0 comments on commit 4477e66

Please sign in to comment.