Metadata-Version: 2.1
Name: quickvision
Version: 0.2.0
Summary: Computer Vision models and training
Home-page: UNKNOWN
Author: Aditya Oke
Author-email: okeaditya315@gmail.com
License: apache2
Download-URL: https://github.com/Quick-AI/quickvision
Project-URL: Bug Tracker, https://github.com/Quick-AI/quickvision/issues
Project-URL: Documentation, https://quick-ai.github.io/quickvision/
Project-URL: Source Code, https://github.com/Quick-AI/quickvision
Keywords: Deep Learning,PyTorch
Platform: UNKNOWN
Classifier: Environment :: Console
Classifier: Natural Language :: English
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Scientific/Engineering :: Image Recognition
Classifier: Topic :: Scientific/Engineering :: Information Analysis
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Requires-Dist: torch (==1.8.1)
Requires-Dist: torchvision (==0.9.1)
Requires-Dist: pytorch-lightning (==1.2.6)
Requires-Dist: scipy (==1.5.4)

# Quickvision

- Faster Computer Vision.

<div align="center">

[![GitHub issues](https://img.shields.io/github/issues/Quick-AI/quickvision)](https://github.com/Quick-AI/quickvision/issues)
[![GitHub forks](https://img.shields.io/github/forks/Quick-AI/quickvision)](https://github.com/Quick-AI/quickvision/network)
[![GitHub stars](https://img.shields.io/github/stars/Quick-AI/quickvision)](https://github.com/Quick-AI/quickvision/stargazers)
[![GitHub license](https://img.shields.io/github/license/Quick-AI/quickvision)](https://github.com/Quick-AI/quickvision/blob/master/LICENSE)
[![codecov](https://codecov.io/gh/Quick-AI/quickvision/branch/master/graph/badge.png?token=VAFPQTQK1I)](https://codecov.io/gh/Quick-AI/quickvision)

![PEP8](https://github.com/Quick-AI/quickvision/workflows/Check%20Code%20formatting/badge.png)
![CI Tests](https://github.com/Quick-AI/quickvision/workflows/CI%20Tests/badge.png)
![Docs](https://github.com/Quick-AI/quickvision/workflows/Deploy%20mkdocs/badge.png)
![PyPi Release](https://github.com/Quick-AI/quickvision/workflows/PyPi%20Release/badge.png)

[![Slack](https://img.shields.io/badge/slack-chat-green.png?logo=slack)](https://join.slack.com/t/quickai/shared_invite/zt-iz7tqk3r-IQa4SoxJGIK5WS8VdZhzeQ)
[![Downloads](https://pepy.tech/badge/quickvision)](https://pepy.tech/project/quickvision)
[![Downloads](https://pepy.tech/badge/quickvision/month)](https://pepy.tech/project/quickvision)
[![Downloads](https://pepy.tech/badge/quickvision/week)](https://pepy.tech/project/quickvision)

</div>

![demo](/assets/demo.png)

### Install Quickvision

- Install from PyPi.
- Current stable `release 0.1.1` needs `PyTorch 1.7.1` and `torchvision 0.8.2`.

    ```
    pip install quickvision
    ```

## What is Quickvision?

- Quickvision makes Computer Vision tasks much faster and easier with PyTorch.

    It provides: -

    1. Easy to use PyTorch native API, for `fit()`, `train_step()`, `val_step()` of models.
    2. Easily customizable and configurable models with various backbones.
    3. A complete PyTorch native interface. All models are `nn.Module`, all the training APIs are optional and not binded to models.
    4. A lightning API which helps to accelerate training over multiple GPUs, TPUs.
    5. A datasets API to convert common data formats very easily and quickly to PyTorch formats.
    6. A minimal package, with very low dependencies.

- Train your models faster. Quickvision has already implemented the long learning in PyTorch.

## Quickvision is just PyTorch!!

- Quickvision does not make you learn a new library. If you know PyTorch, you are good to go!!!
- Quickvision does not abstract any code from PyTorch, nor implements any custom classes over it.
- It keeps the data format in `Tensor` so that you don't need to convert it.

### Do you want just a model with some backbone configuration?

- Use model made by us. It's just a `nn.Module` which has Tensors only Input and Output format.
- Quickvision provides reference scripts too for training it!

### Do you want to train your model but not write lengthy loops?

- Just use our training methods such as `fit()`, `train_step()`, `val_step()`.

### Do you want multi GPU training but worried about model configuration?

- Just subclass the PyTorch Lightning model! 
- Implement the `train_step()`, `val_step()`.


