diff --git a/docs/source/index.rst b/docs/source/index.rst index 6a100ed05c..25a2a38043 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -22,7 +22,7 @@ State-of-the-art NLP for everyone: - Hands-on practitioners - AI/ML/NLP teachers and educators -.. +.. Copyright 2020 The HuggingFace Team. All rights reserved. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with @@ -394,6 +394,7 @@ TensorFlow and/or Flax. pretrained_models examples + troubleshooting custom_datasets notebooks sagemaker diff --git a/docs/source/troubleshooting.md b/docs/source/troubleshooting.md new file mode 100644 index 0000000000..c801548620 --- /dev/null +++ b/docs/source/troubleshooting.md @@ -0,0 +1,30 @@ + + +# Troubleshooting + +This document is to help find solutions for common problems. + +## Firewalled environments + +Some cloud and intranet setups have their GPU instances firewalled to the outside world, so if your script is trying to download model weights or datasets it will first hang and then timeout with an error message like: + +``` +ValueError: Connection error, and we cannot find the requested files in the cached path. +Please try again or make sure your Internet connection is on. +``` + +One possible solution in this situation is to use the ["offline-mode"](https://huggingface.co/transformers/installation.html#offline-mode). diff --git a/src/transformers/modeling_utils.py b/src/transformers/modeling_utils.py index b34b2d4f07..82a0a99179 100755 --- a/src/transformers/modeling_utils.py +++ b/src/transformers/modeling_utils.py @@ -949,6 +949,12 @@ class PreTrainedModel(nn.Module, ModuleUtilsMixin, GenerationMixin): Passing :obj:`use_auth_token=True` is required when you want to use a private model. + .. note:: + + Activate the special `"offline-mode" + `__ to use this method in a firewalled + environment. + Examples:: >>> from transformers import BertConfig, BertModel