Skip to content

Commit

Permalink
Fix(readme): Improve README QuickStart info (axolotl-ai-cloud#1408)
Browse files Browse the repository at this point in the history
* Fix(readme): Improve README QuickStart info

* chore: add to toc
  • Loading branch information
NanoCode012 authored and seungduk-yanolja committed Mar 19, 2024
1 parent 0ecb1ce commit b170c78
Showing 1 changed file with 8 additions and 10 deletions.
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Features:
- [Cloud GPU](#cloud-gpu) - Latitude.sh, JarvisLabs, RunPod
- [Bare Metal Cloud GPU](#bare-metal-cloud-gpu)
- [Windows](#windows)
- [Mac](#mac)
- [Launching on public clouds via SkyPilot](#launching-on-public-clouds-via-skypilot)
- [Dataset](#dataset)
- [How to Add Custom Prompts](#how-to-add-custom-prompts)
Expand Down Expand Up @@ -99,24 +100,14 @@ Get started with Axolotl in just a few steps! This quickstart guide will walk yo

**Requirements**: Python >=3.10 and Pytorch >=2.1.1.

### For developers
```bash
git clone https://github.com/OpenAccess-AI-Collective/axolotl
cd axolotl

pip3 install packaging
```

General case:
```
pip3 install -e '.[flash-attn,deepspeed]'
```

Mac: see https://github.com/OpenAccess-AI-Collective/axolotl/blob/13199f678b9aab39e92961323bdbce3234ee4b2b/docs/mac.md
```
pip3 install -e '.'
```

### Usage
```bash
# preprocess datasets - optional but recommended
Expand Down Expand Up @@ -267,6 +258,13 @@ pip uninstall -y torch_xla[tpu]
#### Windows
Please use WSL or Docker!

#### Mac

Use the below instead of the install method in QuickStart.
```
pip3 install -e '.'
```
More info: [mac.md](/docs/mac.md)

#### Launching on public clouds via SkyPilot
To launch on GPU instances (both on-demand and spot instances) on 7+ clouds (GCP, AWS, Azure, OCI, and more), you can use [SkyPilot](https://skypilot.readthedocs.io/en/latest/index.html):
Expand Down

0 comments on commit b170c78

Please sign in to comment.