From 7b8417e5097eec97e8a3334eb55c0ae01c66bf1d Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:38:14 +0100 Subject: [PATCH 01/26] Update README.md --- README.md | 39 ++++++++++++++++++++++++++++++++++----- 1 file changed, 34 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index c748e675066202..64ca4952e855b8 100644 --- a/README.md +++ b/README.md @@ -247,26 +247,48 @@ The model itself is a regular [Pytorch `nn.Module`](https://pytorch.org/docs/sta ## Installation -### With pip +### 1. With pip This repository is tested on Python 3.9+, Flax 0.4.1+, PyTorch 1.11+, and TensorFlow 2.6+. You should install πŸ€— Transformers in a [virtual environment](https://docs.python.org/3/library/venv.html). If you're unfamiliar with Python virtual environments, check out the [user guide](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/). -First, create a virtual environment with the version of Python you're going to use and activate it. +a) First, create a virtual environment with the version of Python you're going to use and activate it. -Then, you will need to install at least one of Flax, PyTorch, or TensorFlow. -Please refer to [TensorFlow installation page](https://www.tensorflow.org/install/), [PyTorch installation page](https://pytorch.org/get-started/locally/#start-locally) and/or [Flax](https://github.com/google/flax#quick-install) and [Jax](https://github.com/google/jax#installation) installation pages regarding the specific installation command for your platform. +For macOS/Linux: + +---python -m venv env +source env/bin/activate--- + +For Windows: + +---python -m venv env +env\Scripts\activate--- + +b) Install a backend framework: +To use πŸ€— Transformers, you must install at least one of Flax, PyTorch, or TensorFlow. Refer to the official installation guides for platform-specific commands: + +[TensorFlow installation page](https://www.tensorflow.org/install/), +[PyTorch installation page](https://pytorch.org/get-started/locally/#start-locally) and/or [Flax](https://github.com/google/flax#quick-install) and [Jax](https://github.com/google/jax#installation) When one of those backends has been installed, πŸ€— Transformers can be installed using pip as follows: +c) Install πŸ€— Transformers: ```bash pip install transformers ``` If you'd like to play with the examples or need the bleeding edge of the code and can't wait for a new release, you must [install the library from source](https://huggingface.co/docs/transformers/installation#installing-from-source). -### With conda +d) Optional: Install from source for the latest updates: + +---Bash +git clone https://github.com/huggingface/transformers.git +cd transformers +pip install--- + + +### 2. With conda πŸ€— Transformers can be installed using conda as follows: @@ -280,6 +302,13 @@ Follow the installation pages of Flax, PyTorch or TensorFlow to see how to insta > **_NOTE:_** On Windows, you may be prompted to activate Developer Mode in order to benefit from caching. If this is not an option for you, please let us know in [this issue](https://github.com/huggingface/huggingface_hub/issues/1062). +### 3. GPU Setup (Optional) + +For GPU acceleration, install the appropriate CUDA drivers for your system: + +a) PyTorch CUDA Compatibility: ( https://pytorch.org/get-started/locally) +b) TensorFlow GPU Support: () + ## Model architectures **[All the model checkpoints](https://huggingface.co/models)** provided by πŸ€— Transformers are seamlessly integrated from the huggingface.co [model hub](https://huggingface.co/models), where they are uploaded directly by [users](https://huggingface.co/users) and [organizations](https://huggingface.co/organizations). From 90baa07753f0b0e88cdd64cc3c0085d7d29b8c8c Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:42:33 +0100 Subject: [PATCH 02/26] Update README.md --- README.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 64ca4952e855b8..5227b86b014ae1 100644 --- a/README.md +++ b/README.md @@ -253,19 +253,21 @@ This repository is tested on Python 3.9+, Flax 0.4.1+, PyTorch 1.11+, and Tensor You should install πŸ€— Transformers in a [virtual environment](https://docs.python.org/3/library/venv.html). If you're unfamiliar with Python virtual environments, check out the [user guide](https://packaging.python.org/guides/installing-using-pip-and-virtual-environments/). -a) First, create a virtual environment with the version of Python you're going to use and activate it. +**a) First, create a virtual environment with the version of Python you're going to use and activate it.** -For macOS/Linux: +**For macOS/Linux:** ---python -m venv env -source env/bin/activate--- +source env/bin/activate +--- -For Windows: +**For Windows:** ---python -m venv env -env\Scripts\activate--- +env\Scripts\activate +--- -b) Install a backend framework: +**b) Install a backend framework:** To use πŸ€— Transformers, you must install at least one of Flax, PyTorch, or TensorFlow. Refer to the official installation guides for platform-specific commands: [TensorFlow installation page](https://www.tensorflow.org/install/), @@ -273,14 +275,14 @@ To use πŸ€— Transformers, you must install at least one of Flax, PyTorch, or Ten When one of those backends has been installed, πŸ€— Transformers can be installed using pip as follows: -c) Install πŸ€— Transformers: +**c) Install πŸ€— Transformers:** ```bash pip install transformers ``` If you'd like to play with the examples or need the bleeding edge of the code and can't wait for a new release, you must [install the library from source](https://huggingface.co/docs/transformers/installation#installing-from-source). -d) Optional: Install from source for the latest updates: +**d) Optional: Install from source for the latest updates:** ---Bash git clone https://github.com/huggingface/transformers.git From b962abea8249d928d4a0cbffa7b116839b4b1f11 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:46:57 +0100 Subject: [PATCH 03/26] Update README.md --- README.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 5227b86b014ae1..584f05f227b1bb 100644 --- a/README.md +++ b/README.md @@ -256,14 +256,13 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **a) First, create a virtual environment with the version of Python you're going to use and activate it.** **For macOS/Linux:** - ----python -m venv env +--- +python -m venv env source env/bin/activate --- - **For Windows:** - ----python -m venv env +--- +python -m venv env env\Scripts\activate --- From 1ac5018c592a2dacb725a6eaf849f8fb67c6d5a2 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:49:04 +0100 Subject: [PATCH 04/26] Update README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 584f05f227b1bb..f691c0b957f5dc 100644 --- a/README.md +++ b/README.md @@ -256,11 +256,14 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **a) First, create a virtual environment with the version of Python you're going to use and activate it.** **For macOS/Linux:** + --- python -m venv env source env/bin/activate --- + **For Windows:** + --- python -m venv env env\Scripts\activate From 5d9fd1a35b4c2699e9664e061ae4bc30d8daa0ee Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:50:36 +0100 Subject: [PATCH 05/26] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f691c0b957f5dc..392dbdd5e08e1d 100644 --- a/README.md +++ b/README.md @@ -257,7 +257,7 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **For macOS/Linux:** ---- +---Bash python -m venv env source env/bin/activate --- From 21e54df38fdcbbc4988ab4b08556c8cae689e43f Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:53:34 +0100 Subject: [PATCH 06/26] Update README.md --- README.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 392dbdd5e08e1d..f70f21f9c9c160 100644 --- a/README.md +++ b/README.md @@ -257,9 +257,8 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **For macOS/Linux:** ----Bash -python -m venv env -source env/bin/activate +---python -m venv env +source env/bin/activate # For macOS/Linux --- **For Windows:** From cf1a330e9746f3dd168ade5c27571348be0ccf3e Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 20:55:09 +0100 Subject: [PATCH 07/26] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index f70f21f9c9c160..3460ba9325804a 100644 --- a/README.md +++ b/README.md @@ -258,7 +258,9 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **For macOS/Linux:** ---python -m venv env + source env/bin/activate # For macOS/Linux + --- **For Windows:** From bb5f92ec38af3eb049c7af28860e906aba4560dc Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 21:39:56 +0100 Subject: [PATCH 08/26] Update README.md --- README.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/README.md b/README.md index 3460ba9325804a..5c9a13500b4207 100644 --- a/README.md +++ b/README.md @@ -258,9 +258,7 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **For macOS/Linux:** ---python -m venv env - -source env/bin/activate # For macOS/Linux - +>>> source env/bin/activate # For macOS/Linux --- **For Windows:** From 804bc2165565d387128270a1ddedfa227562bad5 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 21:41:34 +0100 Subject: [PATCH 09/26] Update README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5c9a13500b4207..e1371648e91000 100644 --- a/README.md +++ b/README.md @@ -257,8 +257,8 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **For macOS/Linux:** ----python -m venv env ->>> source env/bin/activate # For macOS/Linux +--- python -m venv env +source env/bin/activate # For macOS/Linux --- **For Windows:** From 40ca3cc8b806fefab1cfbcc4517d0d24e39231a0 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 21:45:43 +0100 Subject: [PATCH 10/26] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index e1371648e91000..31ca15420f42b5 100644 --- a/README.md +++ b/README.md @@ -258,7 +258,9 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **For macOS/Linux:** --- python -m venv env + source env/bin/activate # For macOS/Linux + --- **For Windows:** From 4c2cd0ba3f71cc3145512f7f1a70d1fbbc1bc406 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 21:50:27 +0100 Subject: [PATCH 11/26] Update README.md --- README.md | 10 +++------- 1 file changed, 3 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 31ca15420f42b5..d9360968215936 100644 --- a/README.md +++ b/README.md @@ -256,13 +256,9 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt **a) First, create a virtual environment with the version of Python you're going to use and activate it.** **For macOS/Linux:** - ---- python -m venv env - -source env/bin/activate # For macOS/Linux - ---- - +```python -m venv env +source env/bin/activate +``` **For Windows:** --- From f236ceb0c1295aab390ad97fb9ad56ba7e5120b0 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 21:53:07 +0100 Subject: [PATCH 12/26] Update README.md --- README.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index d9360968215936..9e2e819c124c09 100644 --- a/README.md +++ b/README.md @@ -260,11 +260,9 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt source env/bin/activate ``` **For Windows:** - ---- -python -m venv env +``` python -m venv env env\Scripts\activate ---- +``` **b) Install a backend framework:** To use πŸ€— Transformers, you must install at least one of Flax, PyTorch, or TensorFlow. Refer to the official installation guides for platform-specific commands: From 309cf387462e686b2f61e87c0863ebff4c0959ab Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 22:08:07 +0100 Subject: [PATCH 13/26] Update README.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e2e819c124c09..b6847335b3315f 100644 --- a/README.md +++ b/README.md @@ -281,11 +281,11 @@ If you'd like to play with the examples or need the bleeding edge of the code an **d) Optional: Install from source for the latest updates:** ----Bash +```Bash git clone https://github.com/huggingface/transformers.git cd transformers -pip install--- - +pip install +``` ### 2. With conda @@ -306,7 +306,7 @@ Follow the installation pages of Flax, PyTorch or TensorFlow to see how to insta For GPU acceleration, install the appropriate CUDA drivers for your system: a) PyTorch CUDA Compatibility: ( https://pytorch.org/get-started/locally) -b) TensorFlow GPU Support: () +b) TensorFlow GPU Support: (https://www.tensorflow.org/install/pip) ## Model architectures From ea598f92eacf3018d4f68be03a0483cc8b3a3468 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 22:15:03 +0100 Subject: [PATCH 14/26] Update README.md --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index b6847335b3315f..b7e788fecc908a 100644 --- a/README.md +++ b/README.md @@ -306,8 +306,12 @@ Follow the installation pages of Flax, PyTorch or TensorFlow to see how to insta For GPU acceleration, install the appropriate CUDA drivers for your system: a) PyTorch CUDA Compatibility: ( https://pytorch.org/get-started/locally) + b) TensorFlow GPU Support: (https://www.tensorflow.org/install/pip) +**Verify GPU availability:** +```nvidia-smi +``` ## Model architectures **[All the model checkpoints](https://huggingface.co/models)** provided by πŸ€— Transformers are seamlessly integrated from the huggingface.co [model hub](https://huggingface.co/models), where they are uploaded directly by [users](https://huggingface.co/users) and [organizations](https://huggingface.co/organizations). From 8cae929866c92a960194c6de58461e50b909eb88 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 22:16:33 +0100 Subject: [PATCH 15/26] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b7e788fecc908a..66aea00fe0c89f 100644 --- a/README.md +++ b/README.md @@ -310,7 +310,8 @@ a) PyTorch CUDA Compatibility: ( https://pytorch.org/get-started/locally) b) TensorFlow GPU Support: (https://www.tensorflow.org/install/pip) **Verify GPU availability:** -```nvidia-smi +``` +nvidia-smi ``` ## Model architectures From 15a9132b3f6db1da2b78d6366be1bb9723131e7e Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 22:31:00 +0100 Subject: [PATCH 16/26] Update README.md Enhanced installation section with troubleshooting, GPU setup, and OS-specific details. --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 66aea00fe0c89f..bd16bfb7198253 100644 --- a/README.md +++ b/README.md @@ -313,6 +313,30 @@ b) TensorFlow GPU Support: (https://www.tensorflow.org/install/pip) ``` nvidia-smi ``` +### 4. Troubleshooting +**a) Error: Python Version Not Supported:** + +Ensure you’re using Python 3.9 or later: +``` +bash +python --version +``` +**b) Error: Missing Dependencies:** + +Install all required dependencies: +``` +bash +pip install -r requirements.txt +``` +**c) Windows-Specific Issues:** + +Activate Developer Mode if prompted. Alternatively, use a virtual environment: +``` +bash +Copy code +python -m venv env +env\Scripts\activate +``` ## Model architectures **[All the model checkpoints](https://huggingface.co/models)** provided by πŸ€— Transformers are seamlessly integrated from the huggingface.co [model hub](https://huggingface.co/models), where they are uploaded directly by [users](https://huggingface.co/users) and [organizations](https://huggingface.co/organizations). From dc8b2604a2adb080ed8a47727bf65569d2e6ec51 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Wed, 4 Dec 2024 22:37:43 +0100 Subject: [PATCH 17/26] Update README.md Enhanced installation section with troubleshooting, GPU setup, and OS-specific details. --- README.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index bd16bfb7198253..ff167e80f65898 100644 --- a/README.md +++ b/README.md @@ -273,7 +273,7 @@ To use πŸ€— Transformers, you must install at least one of Flax, PyTorch, or Ten When one of those backends has been installed, πŸ€— Transformers can be installed using pip as follows: **c) Install πŸ€— Transformers:** -```bash +``` pip install transformers ``` @@ -281,7 +281,7 @@ If you'd like to play with the examples or need the bleeding edge of the code an **d) Optional: Install from source for the latest updates:** -```Bash +``` git clone https://github.com/huggingface/transformers.git cd transformers pip install @@ -318,21 +318,18 @@ nvidia-smi Ensure you’re using Python 3.9 or later: ``` -bash python --version ``` **b) Error: Missing Dependencies:** Install all required dependencies: ``` -bash pip install -r requirements.txt ``` **c) Windows-Specific Issues:** Activate Developer Mode if prompted. Alternatively, use a virtual environment: ``` -bash Copy code python -m venv env env\Scripts\activate From 5c7516a07a5dbe2aafefbf5a039ca42547d22c2c Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 01:31:44 +0100 Subject: [PATCH 18/26] Update installation.md Updated installation.md to include virtual environment and GPU setup instructions. --- docs/source/en/installation.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index af7c97ef3508ae..9f8cd7fe41ea71 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -34,19 +34,19 @@ You should install πŸ€— Transformers in a [virtual environment](https://docs.pyt Start by creating a virtual environment in your project directory: -```bash -python -m venv .env -``` +### Create and Activate a Virtual Environment -Activate the virtual environment. On Linux and MacOs: +To avoid dependency conflicts, it’s recommended to use a virtual environment. -```bash -source .env/bin/activate +#### For macOS/Linux: ``` -Activate Virtual environment on Windows - -```bash -.env/Scripts/activate +python3 -m venv env +source env/bin/activate +``` +#### For window OS: +``` +python -m venv env +.\env\Scripts\activate ``` Now you're ready to install πŸ€— Transformers with the following command: From f499072585cb31b0338c8bf642565e78e44a30c7 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 01:41:59 +0100 Subject: [PATCH 19/26] Update installation.md Updated installation.md to include virtual environment and GPU setup instructions. --- docs/source/en/installation.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index 9f8cd7fe41ea71..168d8f5e2534b1 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -254,3 +254,12 @@ Once your file is downloaded and locally cached, specify it's local path to load See the [How to download files from the Hub](https://huggingface.co/docs/hub/how-to-downstream) section for more details on downloading files stored on the Hub. + +# Windows-Specific Issues + +If you encounter issues on Windows, you may need to activate Developer Mode. Alternatively, create and activate a virtual environment as shown below: + +``` +python -m venv env +.\env\Scripts\activate +``` From bb947f0f1ecb58c34002c366ad76a3d5c4c4fb13 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 01:49:28 +0100 Subject: [PATCH 20/26] Update installation.md Updated installation.md to include virtual environment, troubleshooting and GPU setup instructions. --- docs/source/en/installation.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index 168d8f5e2534b1..cef33454c9000d 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -255,7 +255,21 @@ See the [How to download files from the Hub](https://huggingface.co/docs/hub/how -# Windows-Specific Issues +# Troubleshooting + +## a) Error: Python Version Not Supported +Ensure you are using Python 3.9 or later. +To check your Python version, run: +``` +python --version +``` +## b) Error: Missing Dependencies + +Install all required dependencies by running: +``` +pip install -r requirements.txt +``` +## c) Windows-Specific Issues If you encounter issues on Windows, you may need to activate Developer Mode. Alternatively, create and activate a virtual environment as shown below: From 5f9b3ed9a16dbb7557a23dabb58738b7a0e91363 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 01:51:10 +0100 Subject: [PATCH 21/26] Update installation.md --- docs/source/en/installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index cef33454c9000d..e45fbe7b2375ba 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -269,6 +269,8 @@ Install all required dependencies by running: ``` pip install -r requirements.txt ``` +Ensure you’re in the project directory before executing the command. + ## c) Windows-Specific Issues If you encounter issues on Windows, you may need to activate Developer Mode. Alternatively, create and activate a virtual environment as shown below: From 3b75bbb5b66bcf82925d0a078e0b4f81e78cc6c4 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 01:56:51 +0100 Subject: [PATCH 22/26] Update installation.md --- docs/source/en/installation.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index e45fbe7b2375ba..75eb72ccf062f5 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -273,7 +273,9 @@ Ensure you’re in the project directory before executing the command. ## c) Windows-Specific Issues -If you encounter issues on Windows, you may need to activate Developer Mode. Alternatively, create and activate a virtual environment as shown below: +If you encounter issues on Windows, you may need to activate Developer Mode. +To enable it, navigate to Windows Settings > For Developers > Developer Mode. +Alternatively, create and activate a virtual environment as shown below: ``` python -m venv env From 751789ea3642c4af68b846a415bb4e50aff21ccf Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 01:57:41 +0100 Subject: [PATCH 23/26] Update installation.md --- docs/source/en/installation.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index 75eb72ccf062f5..d689e1f62daec7 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -274,7 +274,9 @@ Ensure you’re in the project directory before executing the command. ## c) Windows-Specific Issues If you encounter issues on Windows, you may need to activate Developer Mode. + To enable it, navigate to Windows Settings > For Developers > Developer Mode. + Alternatively, create and activate a virtual environment as shown below: ``` From 3fed10678267561223bb43ebfa46ea46f4af6643 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 02:04:06 +0100 Subject: [PATCH 24/26] Update installation.md Updated installation.md to include virtual environment, troubleshooting functions and GPU setup instructions. --- docs/source/en/installation.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index d689e1f62daec7..6c3e61d009641f 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -283,3 +283,9 @@ Alternatively, create and activate a virtual environment as shown below: python -m venv env .\env\Scripts\activate ``` + +### GPU Setup +To enable GPU acceleration for deep learning models, ensure you have the necessary drivers and frameworks installed. Refer to the official guides for setup instructions: +- [TensorFlow Installation Guide](https://www.tensorflow.org/install) +- [PyTorch Installation Guide](https://pytorch.org/get-started) + From bdc7775478a5602880ec2ddb71c69a6d62e77784 Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 02:12:07 +0100 Subject: [PATCH 25/26] Update installation.md Updated installation.md to include virtual environment, troubleshooting functions and GPU setup instructions. --- docs/source/en/installation.md | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index 6c3e61d009641f..07b60db3aa3ada 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -284,8 +284,16 @@ python -m venv env .\env\Scripts\activate ``` -### GPU Setup -To enable GPU acceleration for deep learning models, ensure you have the necessary drivers and frameworks installed. Refer to the official guides for setup instructions: -- [TensorFlow Installation Guide](https://www.tensorflow.org/install) -- [PyTorch Installation Guide](https://pytorch.org/get-started) +### GPU Setup (Optional) +For GPU acceleration, install the appropriate CUDA drivers for your system: + +a) [PyTorch CUDA Compatibility](https://pytorch.org/get-started/locally) +b) [TensorFlow GPU Support](https://www.tensorflow.org/install/pip) + +#### Verify GPU availability: + +To check if your system detects an NVIDIA GPU, run: +```bash +nvidia-smi +``` From 97d45e5ecc984320a4dac2e7e717828ddeb3fe2f Mon Sep 17 00:00:00 2001 From: Ego Joseph Oborakpororo <90655773+egojoseph@users.noreply.github.com> Date: Sat, 4 Jan 2025 02:16:35 +0100 Subject: [PATCH 26/26] Update installation.md Updated installation.md to include virtual environment, troubleshooting functions and GPU setup instructions. --- docs/source/en/installation.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/en/installation.md b/docs/source/en/installation.md index 07b60db3aa3ada..eff7e9a7080037 100644 --- a/docs/source/en/installation.md +++ b/docs/source/en/installation.md @@ -288,8 +288,8 @@ python -m venv env For GPU acceleration, install the appropriate CUDA drivers for your system: -a) [PyTorch CUDA Compatibility](https://pytorch.org/get-started/locally) -b) [TensorFlow GPU Support](https://www.tensorflow.org/install/pip) +a) PyTorch CUDA Compatibility: (https://pytorch.org/get-started/locally) +b) TensorFlow GPU Support: (https://www.tensorflow.org/install/pip) #### Verify GPU availability: