From d719bcd46a70302486f2255f1ff7759e232a0122 Mon Sep 17 00:00:00 2001 From: Zachary Mueller Date: Mon, 9 May 2022 15:45:18 -0400 Subject: [PATCH] Fix all docs for accelerate install directions (#17145) --- docs/source/en/run_scripts.mdx | 3 ++- examples/pytorch/image-classification/README.md | 2 +- examples/pytorch/multiple-choice/README.md | 2 +- examples/pytorch/question-answering/README.md | 2 +- examples/pytorch/summarization/README.md | 2 +- examples/pytorch/text-classification/README.md | 2 +- examples/pytorch/token-classification/README.md | 2 +- examples/pytorch/translation/README.md | 2 +- examples/research_projects/luke/README.md | 2 +- 9 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/source/en/run_scripts.mdx b/docs/source/en/run_scripts.mdx index ca8f8df5e8..368bd910ef 100644 --- a/docs/source/en/run_scripts.mdx +++ b/docs/source/en/run_scripts.mdx @@ -189,8 +189,9 @@ python run_summarization.py \ 🤗 [Accelerate](https://huggingface.co/docs/accelerate/index.html) is a PyTorch-only library that offers a unified method for training a model on several types of setups (CPU-only, multiple GPUs, TPUs) while maintaining complete visibility into the PyTorch training loop. Make sure you have 🤗 Accelerate installed if you don't already have it: +> Note: As Accelerate is rapidly developing, the git version of accelerate must be installed to run the scripts ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` Instead of the `run_summarization.py` script, you need to use the `run_summarization_no_trainer.py` script. 🤗 Accelerate supported scripts will have a `task_no_trainer.py` file in the folder. Begin by running the following command to create and save a configuration file: diff --git a/examples/pytorch/image-classification/README.md b/examples/pytorch/image-classification/README.md index 2070c854c7..5bfe7fa92f 100644 --- a/examples/pytorch/image-classification/README.md +++ b/examples/pytorch/image-classification/README.md @@ -177,7 +177,7 @@ the means of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` You can then use your usual launchers to run in it in a distributed environment, but the easiest way is to run diff --git a/examples/pytorch/multiple-choice/README.md b/examples/pytorch/multiple-choice/README.md index 4e3e331e05..735d1f5f33 100644 --- a/examples/pytorch/multiple-choice/README.md +++ b/examples/pytorch/multiple-choice/README.md @@ -53,7 +53,7 @@ the mean of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) l after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then diff --git a/examples/pytorch/question-answering/README.md b/examples/pytorch/question-answering/README.md index 480da1d89f..f6e660e972 100644 --- a/examples/pytorch/question-answering/README.md +++ b/examples/pytorch/question-answering/README.md @@ -136,7 +136,7 @@ SQuAD or a similar dataset, the main difference is that this script exposes the You can use the script normally after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then diff --git a/examples/pytorch/summarization/README.md b/examples/pytorch/summarization/README.md index bf42e79643..db7f8f4061 100644 --- a/examples/pytorch/summarization/README.md +++ b/examples/pytorch/summarization/README.md @@ -149,7 +149,7 @@ the mean of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) l after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then diff --git a/examples/pytorch/text-classification/README.md b/examples/pytorch/text-classification/README.md index 5f853149e3..3773d873ec 100644 --- a/examples/pytorch/text-classification/README.md +++ b/examples/pytorch/text-classification/README.md @@ -115,7 +115,7 @@ the mean of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) l after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then diff --git a/examples/pytorch/token-classification/README.md b/examples/pytorch/token-classification/README.md index 01f586dff2..130d5e235a 100644 --- a/examples/pytorch/token-classification/README.md +++ b/examples/pytorch/token-classification/README.md @@ -73,7 +73,7 @@ the mean of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) l after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then diff --git a/examples/pytorch/translation/README.md b/examples/pytorch/translation/README.md index 00c03a9be1..4bd66ea0ac 100644 --- a/examples/pytorch/translation/README.md +++ b/examples/pytorch/translation/README.md @@ -162,7 +162,7 @@ the mean of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) l after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then diff --git a/examples/research_projects/luke/README.md b/examples/research_projects/luke/README.md index a4eb137043..703eb0b4e4 100644 --- a/examples/research_projects/luke/README.md +++ b/examples/research_projects/luke/README.md @@ -14,7 +14,7 @@ the mean of the [🤗 `Accelerate`](https://github.com/huggingface/accelerate) l after installing it: ```bash -pip install accelerate +pip install git+https://github.com/huggingface/accelerate ``` then to train English LUKE on CoNLL2003: