diff --git a/README.md b/README.md index 351cf8f71a1c0060423e7b09a0a96171e3eaf8e4..ac7f183f817cc67314e3e6987b3510c7f9f9567f 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,37 @@ -# Code Computer Visions +# Computer Vision system +## Setup + +python37 + +(poetry #TODO) + + +## Repo Organisation + + - [./common] In this directory, we write common code that can be used by every sub-project + - [./dataset] In this directory, we add the images that are part of our dataset + - Sub projects + - [./drone-at-base]: The goal is to detect the base from the drone + - [./robots-at-robots]: The goal is to identify and track the robots + - [./robots-at-runes]: The goal is to infer the runes rotation angle and speed + + +## Sub-project organisation + +The organisation for ech sub-project should follow the structure: + + - a `research` directory, where all the tests / model training, and code that shouldn't be ran by the robots would go + - a `polystar/{sub_project_name}` directory, where the code that should be ran by the robots should go + + +## Goals + +For each project, we defined a few steps toward the automatisation + +0. No automatisation, the pilot does everything +1. The pilot chooses a target, then select a "follow" mode. The CV helps maintaining the shooter facing toward the target. The pilot controls when to shoot. +2. The pilot chooses a target, then select a "shoot" mode. The CV maintain the shooter facing toward the target, and make the shooting decision. +3. The pilot let the CV system to decide when to shoot, and which robot to shoot, depending on the distance to the targets, the probability to hit, and the type of robots. + +The main goal is not to reach step 3 for every project: reaching step 1 would already help a lot the pilots !