xiaoxue_admin
/
supervision
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: 📚 conda and mamba installation methods added 

Signed-off-by: Onuralp SEZER <thunderbirdtr@gmail.com>
This commit is contained in:
Onuralp SEZER 2024-03-28 17:55:11 +03:00
parent ccc7118bcb
commit f9fd88fb01
No known key found for this signature in database
GPG Key ID: CF0835DFDF14CA38
1 changed files with 62 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

101
docs/index.md
View File

@ -33,60 +33,83 @@ We write your reusable computer vision tools. Whether you need to load your data
You can install `supervision` with pip in a
[**Python>=3.8**](https://www.python.org/) environment.
!!! example "pip install (recommended)"
!!! success "Installation"
=== "headless"
The headless installation of `supervision` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
!!! example "Pip installation (recommended)"
```bash
pip install supervision
```
=== "Headless"
The headless installation of `supervision` is designed for environments where graphical user interfaces (GUI) are not needed, making it more lightweight and suitable for server-side applications.
=== "desktop"
If you require the full version of `supervision` with GUI support you can install the desktop version. This version includes the GUI components of OpenCV, allowing you to display images and videos on the screen.
```bash
pip install supervision
```
```bash
pip install "supervision[desktop]"
```
=== "Desktop"
The desktop installation of `supervision` is designed with GUI support. This version includes the GUI components of OpenCV, allowing you to display images and videos on the screen.
!!! example "git clone (for development)"
```bash
pip install "supervision[desktop]"
```
=== "virtualenv"
!!! example "Conda/Mamba installation"
```bash
# clone repository and navigate to root directory
git clone https://github.com/roboflow/supervision.git
cd supervision
=== "conda"
The Conda installation of `supervision` is designed for those who prefer using Conda as their package manager. It's especially useful for managing complex dependencies and environments.
# setup python environment and activate it
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
[![Conda Recipe](https://img.shields.io/badge/recipe-supervision-green.svg)](https://anaconda.org/conda-forge/supervision) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![Conda Version](https://img.shields.io/conda/vn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision)
# headless install
pip install -e "."
# desktop install
pip install -e ".[desktop]"
```
```bash
conda install -c conda-forge supervision
```
=== "poetry"
=== "mamba"
The Mamba installation of `supervision` is ideal for those who prefer using Mamba as their package manager.
```bash
# clone repository and navigate to root directory
git clone https://github.com/roboflow/supervision.git
cd supervision
[![Mamba Recipe](https://img.shields.io/badge/recipe-supervision-green.svg)](https://anaconda.org/conda-forge/supervision) [![Mamba Downloads](https://img.shields.io/conda/dn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![Mamba Version](https://img.shields.io/conda/vn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision) [![Mamba Platforms](https://img.shields.io/conda/pn/conda-forge/supervision.svg)](https://anaconda.org/conda-forge/supervision)
# setup python environment and activate it
poetry env use python3.10
poetry shell
```bash
mamba install -c conda-forge supervision
```
# headless install
poetry install
!!! example "git clone (for development)"
# desktop install
poetry install --extras "desktop"
```
=== "virtualenv"
```bash
# clone repository and navigate to root directory
git clone https://github.com/roboflow/supervision.git
cd supervision
# setup python environment and activate it
python3 -m venv venv
source venv/bin/activate
pip install --upgrade pip
# headless install
pip install -e "."
# desktop install
pip install -e ".[desktop]"
```
=== "poetry"
```bash
# clone repository and navigate to root directory
git clone https://github.com/roboflow/supervision.git
cd supervision
# setup python environment and activate it
poetry env use python3.10
poetry shell
# headless install
poetry install
# desktop install
poetry install --extras "desktop"
```
## 🚀 Quickstart