From 37567235a643c3ece3ae0cc7b58c3db8ca148748 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Gustavo=20Atkinson=20Amorim?= Date: Mon, 14 Mar 2022 13:11:12 -0300 Subject: [PATCH 1/2] replace texts and link (master -> main) --- CONTRIBUTING.md | 8 ++++---- README.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 66b0a853826..3073b338191 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,7 @@ on the awesome projects it made possible, shout out on Twitter every time it has helped you, or simply star the repo to say "thank you". Whichever way you choose to contribute, please be mindful to respect our -[code of conduct](https://github.com/huggingface/accelerate/blob/master/CODE_OF_CONDUCT.md). +[code of conduct](https://github.com/huggingface/accelerate/blob/main/CODE_OF_CONDUCT.md). ## You can contribute in so many ways! @@ -118,7 +118,7 @@ Follow these steps to start contributing: $ git checkout -b a-descriptive-name-for-my-changes ``` - **Do not** work on the `master` branch. + **Do not** work on the `main` branch. 4. Set up a development environment by running the following command in a conda or a virtual environment you've created for working on this library: @@ -184,7 +184,7 @@ Follow these steps to start contributing: ```bash $ git fetch upstream - $ git rebase upstream/master + $ git rebase upstream/main ``` Push the changes to your account using: @@ -220,7 +220,7 @@ See an example of a good PR here: https://github.com/huggingface/accelerate/pull ### Tests An extensive test suite is included to test the library behavior and several examples. Library tests can be found in -the [tests folder](https://github.com/huggingface/accelerate/tree/master/tests). +the [tests folder](https://github.com/huggingface/accelerate/tree/main/tests). We use `pytest` in order to run the tests. From the root of the repository, here's how to run tests with `pytest` for the library: diff --git a/README.md b/README.md index c2713180850..3e21a3ae1f4 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ limitations under the License. Build --> - + License @@ -35,7 +35,7 @@ limitations under the License. GitHub release - + Contributor Covenant

From fd35f2c6acd6ce3143cdcc2b76857e8700ac553c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Gustavo=20Atkinson=20Amorim?= Date: Mon, 14 Mar 2022 14:12:17 -0300 Subject: [PATCH 2/2] replace texts and link (master -> main) --- docs/source/installation.mdx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/source/installation.mdx b/docs/source/installation.mdx index 4564ba00c4a..be8394af7c8 100644 --- a/docs/source/installation.mdx +++ b/docs/source/installation.mdx @@ -55,9 +55,9 @@ Here is how to quickly install `accelerate` from source: pip install git+https://github.com/huggingface/accelerate ``` -Note that this will install not the latest released version, but the bleeding edge `master` version, which you may want to use in case a bug has been fixed since the last official release and a new release hasn't been yet rolled out. +Note that this will install not the latest released version, but the bleeding edge `main` version, which you may want to use in case a bug has been fixed since the last official release and a new release hasn't been yet rolled out. -While we strive to keep `master` operational at all times, if you notice some issues, they usually get fixed within a few hours or a day and and you're more than welcome to help us detect any problems by opening an [Issue](https://github.com/huggingface/accelerate/issues) and this way, things will get fixed even sooner. +While we strive to keep `main` operational at all times, if you notice some issues, they usually get fixed within a few hours or a day and and you're more than welcome to help us detect any problems by opening an [Issue](https://github.com/huggingface/accelerate/issues) and this way, things will get fixed even sooner. Again, you can run: @@ -69,7 +69,7 @@ to check 🤗 Accelerate is properly installed. ## Editable install -If you want to constantly use the bleeding edge `master` version of the source code, or if you want to contribute to the library and need to test the changes in the code you're making, you will need an editable install. This is done by cloning the repository and installing with the following commands: +If you want to constantly use the bleeding edge `main` version of the source code, or if you want to contribute to the library and need to test the changes in the code you're making, you will need an editable install. This is done by cloning the repository and installing with the following commands: ``` bash git clone https://github.com/huggingface/accelerate.git @@ -85,7 +85,7 @@ now this editable install will reside where you clone the folder to, e.g. `~/acc Do note that you have to keep that `accelerate` folder around and not delete it to continue using the 🤗 Accelerate library. -Now, let's get to the real benefit of this installation approach. Say, you saw some new feature has been just committed into `master`. If you have already performed all the steps above, to update your accelerate repo to include all the latest commits, all you need to do is to `cd` into that cloned repository folder and update the clone to the latest version: +Now, let's get to the real benefit of this installation approach. Say, you saw some new feature has been just committed into `main`. If you have already performed all the steps above, to update your accelerate repo to include all the latest commits, all you need to do is to `cd` into that cloned repository folder and update the clone to the latest version: ```bash cd ~/accelerate/