Fix(readme): Improve README QuickStart info (#1408)
Browse files* Fix(readme): Improve README QuickStart info
* chore: add to toc
README.md
CHANGED
|
@@ -28,6 +28,7 @@ Features:
|
|
| 28 |
- [Cloud GPU](#cloud-gpu) - Latitude.sh, JarvisLabs, RunPod
|
| 29 |
- [Bare Metal Cloud GPU](#bare-metal-cloud-gpu)
|
| 30 |
- [Windows](#windows)
|
|
|
|
| 31 |
- [Launching on public clouds via SkyPilot](#launching-on-public-clouds-via-skypilot)
|
| 32 |
- [Dataset](#dataset)
|
| 33 |
- [How to Add Custom Prompts](#how-to-add-custom-prompts)
|
|
@@ -99,24 +100,14 @@ Get started with Axolotl in just a few steps! This quickstart guide will walk yo
|
|
| 99 |
|
| 100 |
**Requirements**: Python >=3.10 and Pytorch >=2.1.1.
|
| 101 |
|
| 102 |
-
### For developers
|
| 103 |
```bash
|
| 104 |
git clone https://github.com/OpenAccess-AI-Collective/axolotl
|
| 105 |
cd axolotl
|
| 106 |
|
| 107 |
pip3 install packaging
|
| 108 |
-
```
|
| 109 |
-
|
| 110 |
-
General case:
|
| 111 |
-
```
|
| 112 |
pip3 install -e '.[flash-attn,deepspeed]'
|
| 113 |
```
|
| 114 |
|
| 115 |
-
Mac: see https://github.com/OpenAccess-AI-Collective/axolotl/blob/13199f678b9aab39e92961323bdbce3234ee4b2b/docs/mac.md
|
| 116 |
-
```
|
| 117 |
-
pip3 install -e '.'
|
| 118 |
-
```
|
| 119 |
-
|
| 120 |
### Usage
|
| 121 |
```bash
|
| 122 |
# preprocess datasets - optional but recommended
|
|
@@ -267,6 +258,13 @@ pip uninstall -y torch_xla[tpu]
|
|
| 267 |
#### Windows
|
| 268 |
Please use WSL or Docker!
|
| 269 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 270 |
|
| 271 |
#### Launching on public clouds via SkyPilot
|
| 272 |
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):
|
|
|
|
| 28 |
- [Cloud GPU](#cloud-gpu) - Latitude.sh, JarvisLabs, RunPod
|
| 29 |
- [Bare Metal Cloud GPU](#bare-metal-cloud-gpu)
|
| 30 |
- [Windows](#windows)
|
| 31 |
+
- [Mac](#mac)
|
| 32 |
- [Launching on public clouds via SkyPilot](#launching-on-public-clouds-via-skypilot)
|
| 33 |
- [Dataset](#dataset)
|
| 34 |
- [How to Add Custom Prompts](#how-to-add-custom-prompts)
|
|
|
|
| 100 |
|
| 101 |
**Requirements**: Python >=3.10 and Pytorch >=2.1.1.
|
| 102 |
|
|
|
|
| 103 |
```bash
|
| 104 |
git clone https://github.com/OpenAccess-AI-Collective/axolotl
|
| 105 |
cd axolotl
|
| 106 |
|
| 107 |
pip3 install packaging
|
|
|
|
|
|
|
|
|
|
|
|
|
| 108 |
pip3 install -e '.[flash-attn,deepspeed]'
|
| 109 |
```
|
| 110 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 111 |
### Usage
|
| 112 |
```bash
|
| 113 |
# preprocess datasets - optional but recommended
|
|
|
|
| 258 |
#### Windows
|
| 259 |
Please use WSL or Docker!
|
| 260 |
|
| 261 |
+
#### Mac
|
| 262 |
+
|
| 263 |
+
Use the below instead of the install method in QuickStart.
|
| 264 |
+
```
|
| 265 |
+
pip3 install -e '.'
|
| 266 |
+
```
|
| 267 |
+
More info: [mac.md](/docs/mac.md)
|
| 268 |
|
| 269 |
#### Launching on public clouds via SkyPilot
|
| 270 |
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):
|