From b6b7663ea7ac9bfd9e4bbf1971cc804783c6bff9 Mon Sep 17 00:00:00 2001 From: Onuralp SEZER Date: Fri, 21 Jul 2023 21:52:09 +0300 Subject: [PATCH 1/2] =?UTF-8?q?docs:=20=20=F0=9F=93=9D=20update=20installa?= =?UTF-8?q?tion=20and=20source=20installation=20methods?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Onuralp SEZER --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++------ 1 file changed, 48 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 89bea7cf..10dd7ff3 100644 --- a/README.md +++ b/README.md @@ -18,21 +18,35 @@ -## 👋 hello +## 👋 Hello **We write your reusable computer vision tools.** Whether you need to load your dataset from your hard drive, draw detections on an image or video, or count how many detections are in a zone. You can count on us! 🤝 -## 💻 install +## 💻 Install Pip install the supervision package in a [**3.11>=Python>=3.8**](https://www.python.org/) environment. +### Headless Installation + +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 or headless applications. To install supervision with the headless version of OpenCV, simply use the following command: + ```bash pip install supervision ``` +### Desktop Installation + +If you require the full version of supervision with GUI support and want to utilize OpenCV's graphical capabilities, you can install the desktop version. This version includes the GUI components of OpenCV, allowing you to interact with images and videos through graphical interfaces. To install supervision with the full version of OpenCV, use the following command: + +```bash +pip install supervision[desktop] +``` +
-👉 install from source +👉 Install from source + +### Virtualenv/Pip Installation Method ```bash # clone repository and navigate to root directory @@ -43,13 +57,41 @@ cd supervision python3 -m venv venv source venv/bin/activate -# install -pip install -e ".[dev]" +# Headless install +pip install -e "." + +# Desktop install +pip install -e ".[desktop]" + +``` + +### Poetry Installation Method + + +```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 shell + +# If you like to speficiy python version +poetry env use python 3.10 # 3.8,3.9 +poetry shell + + +# Headless install +poetry install + +# Desktop install +poetry install --extras "desktop" + ```
-## 🔥 quickstart +## 🔥 Quickstart ### [detections processing](https://roboflow.github.io/supervision/detection/core/) From f1f2728e0d2e96e36d9266fa6bb2b12b82f5f397 Mon Sep 17 00:00:00 2001 From: SkalskiP Date: Fri, 21 Jul 2023 23:11:03 +0200 Subject: [PATCH 2/2] =?UTF-8?q?=F0=9F=93=9D=20updated=20install=20guide?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 66 +++--------------------------------------------- docs/index.md | 70 ++++++++++++++++++++++++++++++++++++++------------- 2 files changed, 57 insertions(+), 79 deletions(-) diff --git a/README.md b/README.md index 10dd7ff3..6f4eb70f 100644 --- a/README.md +++ b/README.md @@ -18,80 +18,22 @@ -## 👋 Hello +## 👋 hello **We write your reusable computer vision tools.** Whether you need to load your dataset from your hard drive, draw detections on an image or video, or count how many detections are in a zone. You can count on us! 🤝 -## 💻 Install +## 💻 install Pip install the supervision package in a [**3.11>=Python>=3.8**](https://www.python.org/) environment. -### Headless Installation - -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 or headless applications. To install supervision with the headless version of OpenCV, simply use the following command: - -```bash -pip install supervision -``` - -### Desktop Installation - -If you require the full version of supervision with GUI support and want to utilize OpenCV's graphical capabilities, you can install the desktop version. This version includes the GUI components of OpenCV, allowing you to interact with images and videos through graphical interfaces. To install supervision with the full version of OpenCV, use the following command: - ```bash pip install supervision[desktop] ``` -
-👉 Install from source +Read more about desktop, headless and local installation in our [guide](https://roboflow.github.io/supervision/). -### Virtualenv/Pip Installation Method - -```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 - -# Headless install -pip install -e "." - -# Desktop install -pip install -e ".[desktop]" - -``` - -### Poetry Installation Method - - -```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 shell - -# If you like to speficiy python version -poetry env use python 3.10 # 3.8,3.9 -poetry shell - - -# Headless install -poetry install - -# Desktop install -poetry install --extras "desktop" - -``` - -
- -## 🔥 Quickstart +## 🔥 quickstart ### [detections processing](https://roboflow.github.io/supervision/detection/core/) diff --git a/docs/index.md b/docs/index.md index 3a14db37..0b9f46b7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,29 +9,65 @@

-## 👋 Welcome +## 👋 Hello -Supervision is a set of easy-to-use utilities that will come in handy in any computer vision project. +We write your reusable computer vision tools. Whether you need to load your dataset from your hard drive, draw detections on an image or video, or count how many detections are in a zone. You can count on us! -**Supervision** is still in -pre-release stage 🚧 Keep your eyes open for potential bugs and be aware that at this stage our API is still fluid and may change. - -## 💻 How to Install +## 💻 Install You can install `supervision` with pip in a [**3.11>=Python>=3.7**](https://www.python.org/) environment. -!!! example "Pip install method (recommended)" +!!! example "pip install (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. -!!! example "Git clone method (for development)" + ```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. - ```bash - git https://github.com/roboflow/supervision.git - cd supervision - pip install -e '.[dev]' - ``` - See contributing section to know more about contributing to the project \ No newline at end of file + ```bash + pip install supervision[desktop] + ``` + +!!! example "git clone (for development)" + + === "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 + + # 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 python 3.10 + poetry shell + + # headless install + poetry install + + # desktop install + poetry install --extras "desktop" + ``` \ No newline at end of file