From 20d15d2ffb9307998f1556451419867ffa5a124c Mon Sep 17 00:00:00 2001 From: Amit Parekh <7276308+amitkparekh@users.noreply.github.com> Date: Tue, 5 Dec 2023 08:36:15 +0800 Subject: [PATCH] docs: add about --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d8e853..7578532 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,13 @@ -This repo holds the object detector and feature extractor for running things. - > [!IMPORTANT] > If you have questions or find bugs or anything, you can contact us in our [organisation's discussion](https://github.com/orgs/emma-heriot-watt/discussions). +## About + +This repository holds the object detector and feature extractor for running things. Essentially, this is the model that takes an image and returns a series of features for that image. This repository can be used as a standalone to extract features before running things on policy, or used as an API to extract features during inference. + ## Writing code and running things ### Run the server for the [Alexa Arena](https://github.com/amazon-science/alexa-arena)