diff --git a/README.md b/README.md index 950edc8..dd0cb43 100644 --- a/README.md +++ b/README.md @@ -24,19 +24,25 @@
-## Supported computer vision tasks + + +Giskard Vision is a comprehensive Python package designed to simplify and streamline a variety of computer vision tasks. Whether you're working on facial landmark detection, image classification, or object detection, Giskard Vision provides the tools you need to evaluate your models with ease. + +## Supported Computer Vision Tasks - **Facial Landmark Detection** ([Readme](https://github.com/Giskard-AI/giskard-vision/blob/main/giskard_vision/landmark_detection/Readme.md)) - **Image Classification** ([Readme](https://github.com/Giskard-AI/giskard-vision/blob/main/giskard_vision/image_classification/Readme.md)) - **Object Detection** ([Readme](https://github.com/Giskard-AI/giskard-vision/blob/main/giskard_vision/object_detection/Readme.md)) +- +## Installation -## Install +To install Giskard Vision, simply use pip: -``` +```bash pip install giskard-vision ``` -To install the repo in dev mode +If you want to contribute to the development or explore the latest features, you can install the repository in development mode: ```shell git clone https://github.com/Giskard-AI/giskard-vision.git @@ -45,15 +51,37 @@ pdm install -G :all source .venv/bin/activate ``` +## Scan +Giskard Vision includes powerful scanning capabilities to evaluate your models. To run a scan, first ensure that you have the `giskard` library installed: +```shell +pip install giskard +``` +Then, you can perform a scan using the following code: +```py +from giskard_vision import scan + +dataloader = ... +model = ... + +results = scan(model, dataloader) +``` +Explore the examples provided to see how to implement scans in different contexts: +- [Facial Landmark Detection Notebook](https://github.com/Giskard-AI/giskard-vision/blob/main/examples/landmark_detection/ffhq_scan.ipynb) +- [Image Classification Notebook](https://github.com/Giskard-AI/giskard-vision/blob/main/examples/image_classification/sc_scan.ipynb) +- [Object Detection Notebook](https://github.com/Giskard-AI/giskard-vision/blob/main/examples/object_detection/racoons_scan.ipynb) + ## Examples -In order to explore the jupyter notebook tutorials, all you need is to install the repo in dev mode and check out `examples` directory. +The `examples` directory contains Jupyter notebook tutorials that demonstrate how to use Giskard Vision for various tasks. To explore these tutorials: + + 1. Install the repository in development mode. + 2. Navigate to the examples directory and open the notebook of interest. ## FAQ #### I am getting `attributeerror: module 'cv2.face' has no attribute 'createlbphfacerecognizer'` when running some examples in dev mode -This is most likely due to the order in which `opencv-contrib-python` module is installed. The following trick should resolve the issue: +This issue usually occurs due to the installation order of the `opencv-contrib-python` module. To resolve it, follow these steps: ```bash pip uninstall opencv-contrib-python