diff --git a/README.md b/README.md index 7196a653..7d280b57 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,10 @@ [![downloads](https://img.shields.io/pypi/dm/supervision)](https://pypistats.org/packages/supervision) [![license](https://img.shields.io/pypi/l/supervision)](https://github.com/roboflow/supervision/blob/main/LICENSE.md) [![python-version](https://img.shields.io/pypi/pyversions/supervision)](https://badge.fury.io/py/supervision) -[![Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/roboflow/supervision/blob/main/demo.ipynb) -[![Gradio](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Roboflow/Annotators) -[![Discord](https://img.shields.io/discord/1159501506232451173)](https://discord.gg/GbfgXGJ8Bk) -[![Built with Material for MkDocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/) +[![colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/roboflow/supervision/blob/main/demo.ipynb) +[![gradio](https://img.shields.io/badge/%F0%9F%A4%97%20Hugging%20Face-Spaces-blue)](https://huggingface.co/spaces/Roboflow/Annotators) +[![discord](https://img.shields.io/discord/1159501506232451173)](https://discord.gg/GbfgXGJ8Bk) +[![built-with-material-for-mkdocs](https://img.shields.io/badge/Material_for_MkDocs-526CFE?logo=MaterialForMkDocs&logoColor=white)](https://squidfunk.github.io/mkdocs-material/) ## 👋 hello @@ -39,7 +39,7 @@ Pip install the supervision package in a pip install supervision ``` -Read more about desktop, headless, and local installation in our [guide](https://roboflow.github.io/supervision/). +Read more about conda, mamba, and installing from source in our [guide](https://roboflow.github.io/supervision/). ## 🔥 quickstart diff --git a/docs/index.md b/docs/index.md index e69ca201..62768b67 100644 --- a/docs/index.md +++ b/docs/index.md @@ -30,87 +30,81 @@ We write your reusable computer vision tools. Whether you need to load your data ## 💻 Install -You can install `supervision` with pip in a +You can install `supervision` in a [**Python>=3.8**](https://www.python.org/) environment. -!!! success "Installation" +!!! example "pip install (recommended)" - !!! example "Pip installation (recommended)" + === "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. - === "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. + ```bash + pip install supervision + ``` - ```bash - pip install supervision - ``` + === "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. - === "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. + ```bash + pip install "supervision[desktop]" + ``` - ```bash - pip install "supervision[desktop]" - ``` +!!! example "conda/mamba install" - !!! example "Conda/Mamba installation" + === "conda" - === "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. + [![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) - [![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) + ```bash + conda install -c conda-forge supervision + ``` + === "mamba" - ```bash - conda install -c conda-forge 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) - === "mamba" - The Mamba installation of `supervision` is ideal for those who prefer using Mamba as their package manager. + ```bash + mamba install -c conda-forge 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) +!!! example "git clone (for development)" - ```bash - mamba install -c conda-forge supervision - ``` + === "virtualenv" - !!! example "git clone (for development)" + ```bash + # clone repository and navigate to root directory + git clone https://github.com/roboflow/supervision.git + cd supervision - === "virtualenv" + # setup python environment and activate it + python3 -m venv venv + source venv/bin/activate + pip install --upgrade pip - ```bash - # clone repository and navigate to root directory - git clone https://github.com/roboflow/supervision.git - cd supervision + # headless install + pip install -e "." - # setup python environment and activate it - python3 -m venv venv - source venv/bin/activate - pip install --upgrade pip + # desktop install + pip install -e ".[desktop]" + ``` - # headless install - pip install -e "." + === "poetry" - # desktop install - pip install -e ".[desktop]" - ``` + ```bash + # clone repository and navigate to root directory + git clone https://github.com/roboflow/supervision.git + cd supervision - === "poetry" + # setup python environment and activate it + poetry env use python3.10 + poetry shell - ```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" - ``` + # headless install + poetry install + # desktop install + poetry install --extras "desktop" + ``` ## 🚀 Quickstart