From 56a23e5ffecc2c87bb6e6c614964ce3b1d7ac210 Mon Sep 17 00:00:00 2001 From: NanoCode012 Date: Sat, 16 Mar 2024 12:11:41 +0900 Subject: [PATCH 1/2] Fix(readme): Improve README QuickStart info --- README.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 826c16045c..8d67d31a3f 100644 --- a/README.md +++ b/README.md @@ -99,24 +99,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 @@ -252,6 +242,13 @@ For cloud GPU providers that support docker images, use [`winglian/axolotl-cloud #### 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): From d64d1ce6b6a626cc5fda4687760f49f77ed43277 Mon Sep 17 00:00:00 2001 From: NanoCode012 Date: Sat, 16 Mar 2024 12:12:43 +0900 Subject: [PATCH 2/2] chore: add to toc --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 8d67d31a3f..f52b47fb1b 100644 --- a/README.md +++ b/README.md @@ -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)