diff --git a/docs/source/sagemaker.md b/docs/source/sagemaker.md index f75dd979005452..6a3cadec5b303e 100644 --- a/docs/source/sagemaker.md +++ b/docs/source/sagemaker.md @@ -275,7 +275,7 @@ huggingface_estimator = HuggingFace( transformers_version='4.4.2', pytorch_version='1.6.0', py_version='py36', - hyperparameters = hyperparameters + hyperparameters = hyperparameters, distribution = distribution ) ``` @@ -323,7 +323,9 @@ huggingface_estimator = HuggingFace( ### Git Repository -When you create a `HuggingFace` Estimator, you can specify a [training script that is stored in a GitHub repository](https://sagemaker.readthedocs.io/en/stable/overview.html#use-scripts-stored-in-a-git-repository) as the entry point for the estimator, so that you don’t have to download the scripts locally. If Git support is enabled, then `entry_point` and `source_dir` should be relative paths in the Git repo if provided. +When you create a `HuggingFace` Estimator, you can specify a [training script that is stored in a GitHub repository](https://sagemaker.readthedocs.io/en/stable/overview.html#use-scripts-stored-in-a-git-repository) as the entry point for the estimator, so that you don’t have to download the scripts locally. If Git support is enabled, the `entry_point` and `source_dir` should be relative paths in the Git repo if provided. + +If you are using `git_config` to run the [🤗 Transformers examples scripts](https://github.com/huggingface/transformers/tree/master/examples) keep in mind that you need to configure the right `'branch'` for you `transformers_version`, e.g. if you use `transformers_version='4.4.2` you have to use `'branch':'v4.4.2'`. As an example to use `git_config` with an [example script from the transformers repository](https://github.com/huggingface/transformers/tree/master/examples/text-classification). @@ -333,7 +335,7 @@ _Tip: define `output_dir` as `/opt/ml/model` in the hyperparameter for the scrip ```python # configure git settings -git_config = {'repo': 'https://github.com/huggingface/transformers.git','branch': 'master'} +git_config = {'repo': 'https://github.com/huggingface/transformers.git','branch': 'v4.4.2'} # v4.4.2 is referring to the `transformers_version you use in the estimator. # create the Estimator huggingface_estimator = HuggingFace(