Update README.md

README.md

@@ -7,4 +7,71 @@ sdk: static
 pinned: false
 ---
 
+<div align="center">
+
+<img src="https://raw.githubusercontent.com/blinjrm/detection-datasets/main/images/dd_logo.png" alt="logo" width="100"/>
+
+<br>
+
+# Detection datasets
+
+<a href="https://www.python.org/"><img alt="Python" src="https://img.shields.io/badge/-Python 3.7-blue?style=flat-square&logo=python&logoColor=white"></a>
+<a href="https://black.readthedocs.io/en/stable/"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-black.svg?style=flat-square&labelColor=gray"></a>
+<a href="https://github.com/blinjrm/detection-datasets/actions/workflows/ci.yaml"><img src="https://img.shields.io/github/workflow/status/blinjrm/detection-datasets/CI?label=CI&style=flat-square"/></a>
+<a href="https://github.com/blinjrm/detection-datasets/actions/workflows/pypi.yaml"><img src="https://img.shields.io/github/workflow/status/blinjrm/detection-datasets/Python%20package?label=Build&style=flat-square"/></a>
+<a href="https://pypi.org/project/detection-datasets/"><img src="https://img.shields.io/pypi/status/detection-datasets?style=flat-square"/></a>
+
+<br>
+
+*Easily load and transform datasets for object detection.*
+
+</div>
+<br>
+
+---
+
+**Documentation**: https://blinjrm.github.io/detection-datasets/
+
+**Source Code**: https://github.com/blinjrm/detection-datasets
+
+**Datasets on Hugging Face Hub**: https://huggingface.co/detection-datasets
+
+---
+
+<br>
+
+`detection_datasets` aims to make it easier to work with detection datasets.  
+
+This library works alongside the [Detection dataset](https://huggingface.co/detection-datasets) organisation on the Hugging Face Hub, where some detection datasets have been uploaded in the format expected by the library, and are ready to use.  
+
+The main features are:
+* **Read** the dataset :
+    * From disk if it has already been downloaded.
+    * Directly from the Hugging Face Hub if it [already exist](https://huggingface.co/detection-datasets).
+* **Transform** the dataset:
+    * Select a subset of data.
+    * Remap categories.
+    * Create new train-val-test splits.
+* **Visualize** the annotations and images.
+* **Write** the dataset:
+    * To disk, selecting the target detection format: `COCO`, `YOLO` and more to come.
+    * To the Hugging Face Hub for easy reuse in a different environment and share with the community.
+
+<br>
+
+<div align="center">
+
+---
+
+*Read the quick start bellow, or directly jump to the tutorials:*
+
+| Goal                                 | Tutorial | Colab |
+|--------------------------------------|:--------:|:-----:|
+| Load from disk and upload to the Hub | [Open in the docs](https://blinjrm.github.io/detection-datasets/tutorials/1_Read/)     | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/blinjrm/detection-datasets/blob/main/docs/tutorials/1_Read.ipynb)      |
+| Load from the Hub and transform          | [Open in the docs](https://blinjrm.github.io/detection-datasets/tutorials/2_Transform/)     | [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/blinjrm/detection-datasets/blob/main/docs/tutorials/2_Transform.ipynb)      |
+
+---
+
+</div>
+
 More datasets to come! 🔥