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

Merge pull request #214 from onuralpszr/readme-installation-docs 

docs:  📝 update installation and source installation methods
This commit is contained in:
Piotr Skalski 2023-07-21 23:52:51 +02:00 committed by GitHub
parent 3d074fa213 f1f2728e0d
commit d6883caadc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 55 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -28,26 +28,10 @@ Pip install the supervision package in a
[**3.11>=Python>=3.8**](https://www.python.org/) environment.
```bash
pip install supervision
pip install supervision[desktop]
```
<details close>
<summary>👉 install from source</summary>
```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
# install
pip install -e ".[dev]"
```
</details>
Read more about desktop, headless and local installation in our [guide](https://roboflow.github.io/supervision/).
## 🔥 quickstart

70
docs/index.md
View File

@ -9,29 +9,65 @@
</p>
</div>
## 👋 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
```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"
```