Last updated: Apr 9, 2024
Reading timeยท10 min
The Python "ModuleNotFoundError: No module named 'transformers'" occurs when
we forget to install the transformers
module before importing it or install it
in an incorrect environment.
To solve the error, install the module by running the
pip install transformers
command.
Open your terminal in your project's root directory and install the
transformers
module.
# ๐๏ธ In a virtual environment or using Python 2 pip install transformers # ๐๏ธ For Python 3 (could also be pip3.10 depending on your version) pip3 install transformers # ๐๏ธ If you get a permissions error sudo pip3 install transformers pip install transformers --user # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 (could also be pip3.10 depending on your version) python3 -m pip install transformers # ๐๏ธ Using py alias (Windows) py -m pip install transformers # ๐๏ธ For Anaconda conda install -c conda-forge transformers # ๐๏ธ For Jupyter Notebook !pip install transformers
After you install the transformers package, try importing it as follows.
from transformers import pipeline classifier = pipeline('sentiment-analysis') print(classifier('We are very happy to introduce pipeline to the transformers repository.'))
The error occurs for multiple reasons:
transformers
package installed by running
pip install transformers
.transformers.py
which would shadow the official module.transformers
which would shadow the imported
variable.If the error persists, get your Python version and make sure you are installing the package using the correct Python version.
python --version
For example, my Python version is 3.10.4
, so I would install the
transformers
package with pip3.10 install transformers
.
pip3.10 install transformers # ๐๏ธ If you get a permissions error use pip3 (NOT pip3.X) sudo pip3 install transformers
Notice that the version number corresponds to the version of pip
I'm using.
If the PATH for pip
is not set up on your machine, replace pip
with
python3 -m pip
:
# ๐๏ธ Make sure to use your version of Python, e.g. 3.10 python3 -m pip install transformers
If the error persists, try restarting your IDE and development server/script.
You can
check if you have the transformers
package installed
by running the pip show transformers
command.
# ๐๏ธ Check if you have transformers installed pip show transformers # ๐๏ธ If you don't have pip set up in PATH python -m pip show transformers
The pip show transformers
command will either state that the package is not
installed or show a bunch of information about the package, including the
location where the package is installed.
If the package is not installed, make sure your IDE is using the correct version of Python.
transformers
package using the incorrect version or your IDE might be set up to use a different version.For example, In VSCode, you can press CTRL + Shift + P
or (โ
+ Shift
+ P
on Mac) to open the command palette.
Then type "Python select interpreter" in the field.
Then Select the correct Python version from the dropdown menu.
If you are using a virtual environment, make sure you are installing
transformers
in your virtual environment and not globally.
You can try creating a virtual environment if you don't already have one.
# ๐๏ธ Use the correct version of Python when creating VENV python3 -m venv venv # ๐๏ธ Activate on Unix or MacOS source venv/bin/activate # ๐๏ธ Activate on Windows (cmd.exe) venv\Scripts\activate.bat # ๐๏ธ Activate on Windows (PowerShell) venv\Scripts\Activate.ps1 # ๐๏ธ Install transformers in your virtual environment pip install transformers
If the python3 -m venv venv
command doesn't work, try the following 2
commands:
python -m venv venv
py -m venv venv
Your virtual environment will use the version of Python that was used to create it.
transformers.py
because that would shadow the original transformers
module.You also shouldn't be declaring a variable named transformers
as that would
also shadow the original module.
If the error is not resolved, try to uninstall the transformers
package and
then install it.
# ๐๏ธ Check if you have transformers installed pip show transformers # ๐๏ธ If you don't have pip set up in PATH python -m pip show transformers # ๐๏ธ Uninstall transformers pip uninstall transformers # ๐๏ธ If you don't have pip set up in PATH python -m pip uninstall transformers # ๐๏ธ Install transformers pip install transformers # ๐๏ธ If you don't have pip set up in PATH python -m pip install transformers
Try restarting your IDE and development server/script.
You can also try to upgrade the version of the transformers
package.
pip install transformers --upgrade # ๐๏ธ If you don't have pip set up in PATH python -m pip install transformers --upgrade
transformers
.To install the transformers
module on Windows:
pip install transformers
and press Enter.pip install transformers # ๐๏ธ For Python 3 pip3 install transformers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 python3 -m pip install transformers # ๐๏ธ Using py alias py -m pip install transformers # ๐๏ธ If you get a permissions error pip install transformers --user # ๐๏ธ For Anaconda conda install -c conda-forge transformers
If the command doesn't succeed, try running CMD as an administrator.
If you get the error
'pip' is not recognized as an internal or external command,
use the python -m
command when installing transformers
.
python -m pip install transformers python3 -m pip install transformers py -m pip install transformers
Alternatively, you can install the transformers
module in a virtual
environment:
Shift
and right-click in Explorer.# ๐๏ธ Might also be: "python3 -m venv venv" python -m venv venv # ๐๏ธ Activate on Windows (PowerShell) venv\Scripts\Activate.ps1 # ๐๏ธ Activate on Windows (cmd.exe) venv\Scripts\activate.bat # ๐๏ธ Install transformers in your virtual environment pip install transformers
If the python -m venv venv
command doesn't work, try the following 2 commands:
python3 -m venv venv
py -m venv venv
.If you see an error message that ps1 cannot be loaded because running scripts is disabled on this system, run the following command, type "yes" when prompted and rerun the activation command.
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
transformers
module is installed by using the pip show transformers
command.pip show transformers pip3 show transformers python -m pip show transformers python3 -m pip show transformers
The pip show transformers
command will either state that the package is not
installed or show a bunch of information about the package, including the
location where the package is installed.
To install transformers on macOS or Linux:
pip install transformers
and press Enter.pip install transformers # ๐๏ธ For Python 3 pip3 install transformers # ๐๏ธ If you get a permissions error sudo pip3 install transformers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 python3 -m pip install transformers # ๐๏ธ Alternative if you get a permissions error pip install transformers --user # ๐๏ธ For Anaconda conda install -c conda-forge transformers
If you get an error that pip
isn't found, use the python -m
command.
python -m pip install transformers python3 -m pip install transformers
If you get a permissions error, prefix the command with sudo
.
sudo pip install transformers sudo pip3 install transformers
Alternatively, you can install the transformers
package in a virtual
environment:
# ๐๏ธ Could also be "python -m venv venv" python3 -m venv venv # ๐๏ธ Activate virtual env on macOS or Linux source venv/bin/activate # ๐๏ธ Install transformers in your virtual environment pip install transformers
Your virtual environment will use the version of Python that was used to create it.
python3 -m venv venv
command doesn't work, use python -m venv venv
instead.You can use the pip show
command to verify
transformers
has been installed
successfully.
pip show transformers pip3 show transformers python -m pip show transformers python3 -m pip show transformers
The pip show transformers
command will either state that the package is not
installed or show a bunch of information about the package.
To install transformers in Visual Studio Code:
pip install transformers
command to install the transformers
module.pip install transformers # ๐๏ธ For Python 3 pip3 install transformers # ๐๏ธ If you get a permissions error sudo pip3 install transformers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 python3 -m pip install transformers # ๐๏ธ Using py alias py -m pip install transformers # ๐๏ธ Alternative if you get a permissions error pip install transformers --user
CTRL+Shift+P
and then type "View: Toggle Terminal".When installing Python modules in Visual Studio code, make sure that your IDE is configured to use the correct Python version.
Press CTRL+Shift+P
or (โ
+ Shift
+ P
on Mac) to open the command
palette.
Then type "Python select interpreter" in the field.
Then Select the correct Python version from the dropdown menu.
You can use the python --version
command if you need to get your version of
Python.
python --version python3 --version
You can also try creating a virtual environment if you don't already have one.
# ๐๏ธ Could also be "python -m venv venv" or "py -m venv venv" python3 -m venv venv # ๐๏ธ Activate on Unix or MacOS source venv/bin/activate # ๐๏ธ Activate on Windows (cmd.exe) venv\Scripts\activate.bat # ๐๏ธ Activate on Windows (PowerShell) venv\Scripts\Activate.ps1 # ๐๏ธ Install transformers in your virtual environment pip install transformers
Your virtual environment will use the version of Python that was used to create it.
To install transformers in PyCharm:
Alt+F12
on your keyboard to open the terminal.pip install transformers
command to install the transformers
module.pip install transformers # ๐๏ธ For Python 3 pip3 install transformers # ๐๏ธ If you get a permissions error sudo pip3 install transformers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 python3 -m pip install transformers # ๐๏ธ Using py alias py -m pip install transformers # ๐๏ธ Alternative if you get a permissions error pip install transformers --user
Alternatively, you can use the IDE itself to install the module.
+
icon and type transformers
.Click on "File" > "Settings" > "Project" > "Python Interpreter".
Then Select the correct Python version from the dropdown menu.
You can use the python --version
command if you need to get your version of
Python.
python --version python3 --version
To install transformers in Anaconda:
transformers
in the search bar to the right.transformers
package and click on "Apply".Alternatively, you can install the transformers
package with a command.
If you are on Windows, search for "Anaconda Prompt" and open the application.
If you are on macOS or Linux, open your terminal.
Run the following command to install the transformers
package.
# ๐๏ธ Using conda conda install -c conda-forge transformers # ๐๏ธ Alternatively use `pip` pip install transformers # ๐๏ธ For Python 3 pip3 install transformers # ๐๏ธ If you get a permissions error sudo pip3 install transformers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 python3 -m pip install transformers # ๐๏ธ Using py alias py -m pip install transformers # ๐๏ธ Alternative if you get a permissions error pip install transformers --user
Click on the following article if you need to install a specific version of the package using Anaconda.
To install transformers in Jupyter Notebook:
pip install transformers
and press Enter.# ๐๏ธ Using pip pip install transformers # ๐๏ธ For Python 3 pip3 install transformers # ๐๏ธ If you get a permissions error sudo pip3 install transformers # ๐๏ธ If you don't have pip in your PATH environment variable python -m pip install transformers # ๐๏ธ For Python 3 python3 -m pip install transformers # ๐๏ธ Using py alias py -m pip install transformers # ๐๏ธ Using conda conda install -c conda-forge transformers # ๐๏ธ Alternative if you get a permissions error pip install transformers --user
Alternatively, you can use the Python ipykernel
.
Click on "New" and then click on "Python 3 (ipykernel)".
Type !pip install transformers
and click on "Run".
Note that the pip install
command must be prefixed with an exclamation mark if
you use this approach.
!pip install transformers
Once you type the command, click "Run" to install the transformers
module.
If you get a permissions error, e.g. "[WinError: 5] Access is denied", add the
--user
option to the installation command.
!pip install transformers --user
If the error persists, try to restart the Jupyter Kernel and rerun the command.