Skip to content

Commit

Permalink
Clean up of user guide
Browse files Browse the repository at this point in the history
Second commit. Focused on cleaning up feedback from Scott's review as well as additional fixes to a couple broken links.
  • Loading branch information
amd-chrissosa committed Nov 14, 2024
1 parent c3f4e7f commit 6dfbc95
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 17 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,8 @@ llama | [`sharktank/sharktank/models/llama/`](https://github.com/nod-ai/SHA

## SHARK Users

If you're looking to use SHARK check out our [User Guide](docs/README.md).
If you're looking to use SHARK check out our [User Guide](docs/user_guide.md).

## SHARK Developers

If you're looking to develop SHARK, check out our [Developer Guide](docs/developer.md).
If you're looking to develop SHARK, check out our [Developer Guide](docs/developer_guide.md).
File renamed without changes.
15 changes: 6 additions & 9 deletions docs/README.md → docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Our current user guide requires that you have:

## Set up Environment

You will need a recent version of Python. We recommend also setting up a Python environment.
This section will help you install Python and set up a Python environment with venv.

Officially we support Python versions: 3.11, 3.12, 3.13, 3.13t

Expand All @@ -33,7 +33,7 @@ which python3.11

### Create a Python Environment

This guide assumes you'll be using pyenv. Setup your pyenv with the following commands:
Setup your Python environment with the following commands:

```bash
# Set up a virtual environment to isolate packages from other envs.
Expand All @@ -44,10 +44,7 @@ source 3.11.venv/bin/activate
## Install SHARK and its dependencies

```bash
pip install transformers
pip install dataclasses-json
pip install pillow
pip install shark-ai
pip install shark-ai[apps]
```

Temporarily, you may need an update to your `shortfin` install.
Expand All @@ -64,11 +61,11 @@ python -m shortfin_apps.sd.server --help

## Quickstart

### Run the SD Server
### Run the SDXL Server

Run the [SD Server](../shortfin/python/shortfin_apps/sd/README.md#Start SD Server)
Run the [SDXL Server](../shortfin/python/shortfin_apps/sd/README.md#Start-SDXL-Server)

### Run the SD Client
### Run the SDXL Client

```
python -m shortfin_apps.sd.simple_client --interactive
Expand Down
11 changes: 5 additions & 6 deletions shortfin/python/shortfin_apps/sd/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
# SD Server and CLI

This directory contains a SD inference server, CLI and support components.
# SDXL Server and CLI

This directory contains a [SDXL](https://stablediffusionxl.com/) inference server, CLI and support components. More information about SDXL on [huggingface](https://huggingface.co/stabilityai/stable-diffusion-xl-base-1.0).

## Install

For [nightly releases](../../../../docs/nightly_releases.md)
For our [stable release](../../../../docs/README.md)
For our [stable release](../../../../docs/user_guide.md)

## Start SD Servier
## Start SDXL Server
The server will prepare runtime artifacts for you.

By default, the port is set to 8000. If you would like to change this, use `--port` in each of the following commands.
Expand All @@ -23,7 +22,7 @@ python -m shortfin_apps.sd.server --device=amdgpu --device_ids=0 --build_prefere
INFO - Application startup complete.
INFO - Uvicorn running on http://0.0.0.0:8000 (Press CTRL+C to quit)
```
## Run the SD Client
## Run the SDXL Client

- Run a CLI client in a separate shell:
```
Expand Down

0 comments on commit 6dfbc95

Please sign in to comment.