Spaces:
Sleeping
Sleeping
📝 [Finish] first section docs
Browse files
docs/0_get_start/1_installations.rst
DELETED
|
@@ -1,15 +0,0 @@
|
|
| 1 |
-
Install YOLO
|
| 2 |
-
============
|
| 3 |
-
|
| 4 |
-
Git
|
| 5 |
-
---
|
| 6 |
-
|
| 7 |
-
pypi(pip install)
|
| 8 |
-
-----------------
|
| 9 |
-
|
| 10 |
-
Docker
|
| 11 |
-
------
|
| 12 |
-
|
| 13 |
-
Conda
|
| 14 |
-
-----
|
| 15 |
-
[WIP]
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
docs/0_get_start/1_introduction.rst
ADDED
|
@@ -0,0 +1,9 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
What is YOLO
|
| 2 |
+
============
|
| 3 |
+
|
| 4 |
+
|
| 5 |
+
Forward Proccess
|
| 6 |
+
----------------
|
| 7 |
+
|
| 8 |
+
Loss Function
|
| 9 |
+
-------------
|
docs/0_get_start/2_installations.rst
ADDED
|
@@ -0,0 +1,85 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
Install YOLO
|
| 2 |
+
============
|
| 3 |
+
|
| 4 |
+
This guide will help you set up YOLO on your machine.
|
| 5 |
+
We recommend starting with `GitHub Settings <#git-github>`_ for more flexible customization.
|
| 6 |
+
If you are planning to perform inference only or require a simple customization, you can choose to install via `PyPI <#pypi-pip-install>`_.
|
| 7 |
+
|
| 8 |
+
Torch Requirements
|
| 9 |
+
-------------------
|
| 10 |
+
|
| 11 |
+
The following table summarizes the torch requirements for different operating systems and hardware configurations:
|
| 12 |
+
|
| 13 |
+
.. flat-table::
|
| 14 |
+
|
| 15 |
+
* - OS
|
| 16 |
+
- :cspan:`1` Linux
|
| 17 |
+
- :cspan:`1` MacOS
|
| 18 |
+
- :cspan:`1` Windows
|
| 19 |
+
* - Hardware
|
| 20 |
+
- CUDA
|
| 21 |
+
- CPU
|
| 22 |
+
- MPS
|
| 23 |
+
- CPU
|
| 24 |
+
- CUDA
|
| 25 |
+
- CPU
|
| 26 |
+
* - PyTorch
|
| 27 |
+
- 1.12+
|
| 28 |
+
- 1.12+
|
| 29 |
+
- 1.12+
|
| 30 |
+
- 2.3+
|
| 31 |
+
- [WIP]
|
| 32 |
+
- [WIP]
|
| 33 |
+
|
| 34 |
+
Git & GitHub
|
| 35 |
+
------------
|
| 36 |
+
|
| 37 |
+
First, Clone the repository:
|
| 38 |
+
|
| 39 |
+
.. code-block:: bash
|
| 40 |
+
|
| 41 |
+
git clone https://github.com/WongKinYiu/YOLO.git
|
| 42 |
+
|
| 43 |
+
Alternatively, you can directly download the repository via this `link <https://github.com/WongKinYiu/YOLO/archive/refs/heads/main.zip>`_.
|
| 44 |
+
|
| 45 |
+
Next, install the required packages:
|
| 46 |
+
|
| 47 |
+
.. code-block:: bash
|
| 48 |
+
|
| 49 |
+
# For the minimal requirements, use:
|
| 50 |
+
pip install -r requirements.txt
|
| 51 |
+
# For a full installation, use:
|
| 52 |
+
pip install -r requirements-dev.txt
|
| 53 |
+
|
| 54 |
+
Moreover, if you plan to utilize ONNX or TensorRT, please follow :ref:`ONNX`, :ref:`TensorRT` for more installation details.
|
| 55 |
+
|
| 56 |
+
PyPI (pip install)
|
| 57 |
+
------------------
|
| 58 |
+
|
| 59 |
+
.. note::
|
| 60 |
+
Due to the :guilabel:`yolo` this name already being occupied in the PyPI library, we are still determining the package name.
|
| 61 |
+
Currently, we provide an alternative way to install via the GitHub repository. Ensure your shell has `git` and `pip3` (or `pip`).
|
| 62 |
+
|
| 63 |
+
To install YOLO via GitHub:
|
| 64 |
+
|
| 65 |
+
.. code-block:: bash
|
| 66 |
+
|
| 67 |
+
pip install git+https://github.com/WongKinYiu/YOLO.git
|
| 68 |
+
|
| 69 |
+
Docker
|
| 70 |
+
------
|
| 71 |
+
|
| 72 |
+
To run YOLO using NVIDIA Docker, you can pull the Docker image and run it with GPU support:
|
| 73 |
+
|
| 74 |
+
.. code-block:: bash
|
| 75 |
+
|
| 76 |
+
docker pull henrytsui000/yolo
|
| 77 |
+
docker run --gpus all -it henrytsui000/yolo
|
| 78 |
+
|
| 79 |
+
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>`_.
|
| 80 |
+
|
| 81 |
+
|
| 82 |
+
Conda
|
| 83 |
+
-----
|
| 84 |
+
|
| 85 |
+
We will publish it in the near future!
|
docs/index.rst
CHANGED
|
@@ -26,7 +26,8 @@ Explore our documentation:
|
|
| 26 |
:caption: Get Started
|
| 27 |
|
| 28 |
0_get_start/0_quick_start
|
| 29 |
-
0_get_start/
|
|
|
|
| 30 |
|
| 31 |
.. toctree::
|
| 32 |
:maxdepth: 1
|
|
|
|
| 26 |
:caption: Get Started
|
| 27 |
|
| 28 |
0_get_start/0_quick_start
|
| 29 |
+
0_get_start/1_introduction
|
| 30 |
+
0_get_start/2_installations
|
| 31 |
|
| 32 |
.. toctree::
|
| 33 |
:maxdepth: 1
|