File size: 2,413 Bytes
2cd6792 0f23de9 2cd6792 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
Install YOLO
============
This guide will help you set up YOLO on your machine.
We recommend starting with `GitHub Settings <#git-github>`_ for more flexible customization.
If you are planning to perform inference only or require a simple customization, you can choose to install via `PyPI <#pypi-pip-install>`_.
Torch Requirements
-------------------
The following table summarizes the torch requirements for different operating systems and hardware configurations:
.. tabs::
.. tab:: Linux
.. tabs::
.. tab:: CUDA
PyTorch: 1.12+
.. tab:: CPU
PyTorch: 1.12+
.. tab:: MacOS
.. tabs::
.. tab:: MPS
PyTorch: 2.2+
.. tab:: CPU
PyTorch: 2.2+
.. tab:: Windows
.. tabs::
.. tab:: CUDA
[WIP]
.. tab:: CPU
[WIP]
Git & GitHub
------------
First, Clone the repository:
.. code-block:: bash
git clone https://github.com/WongKinYiu/YOLO.git
Alternatively, you can directly download the repository via this `link <https://github.com/WongKinYiu/YOLO/archive/refs/heads/main.zip>`_.
Next, install the required packages:
.. code-block:: bash
# For the minimal requirements, use:
pip install -r requirements.txt
# For a full installation, use:
pip install -r requirements-dev.txt
Moreover, if you plan to utilize ONNX or TensorRT, please follow :ref:`ONNX`, :ref:`TensorRT` for more installation details.
PyPI (pip install)
------------------
.. note::
Due to the :guilabel:`yolo` this name already being occupied in the PyPI library, we are still determining the package name.
Currently, we provide an alternative way to install via the GitHub repository. Ensure your shell has `git` and `pip3` (or `pip`).
To install YOLO via GitHub:
.. code-block:: bash
pip install git+https://github.com/WongKinYiu/YOLO.git
Docker
------
To run YOLO using NVIDIA Docker, you can pull the Docker image and run it with GPU support:
.. code-block:: bash
docker pull henrytsui000/yolo
docker run --gpus all -it henrytsui000/yolo
Make sure you have the NVIDIA Docker toolkit installed. For more details on setting up NVIDIA Docker, refer to the `NVIDIA Docker documentation <https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/install-guide.html>`_.
Conda
-----
We will publish it in the near future!
|