diff --git a/docs/index.md b/docs/index.md index 0b1ad14..0f326e5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,17 @@ -.. mdinclude:: ../README.md +# mira + +mira provides tooling for simple object detection projects. The package spans three areas of focus. + +- **Core** object detection abstractions for images and annotations +- Access to **datasets** from common formats (e.g., VOC, COCO) and image sets (e.g., VOC 2012) +- A common API to for **well-known models** (e.g., RetinaNet and YOLO) + +## Installation + +```shell +pip install mira +``` + .. toctree:: tutorials/index