Repository
==========

After successfully installing **kitcar-machine-learning**.
You are now confronted with our repository.
Before going into any details, we will now take a step back and look at the repository's structure.

Root
----

When opening the repository in a file browser you will see the following files and directories:

.. program-output::
  cd $KITCAR_REPO_PATH/kitcar-machine-learning/ && tree -I __pycache__ -L 1 --dirsfirst .
  :shell:

Docs
----

The ``docs/`` directory contains our documentation.
We use `Sphinx <https://www.sphinx-doc.org/en/master/>`_ \
and `better-apidoc <https://github.com/goerz/better-apidoc>`_ \
to easily create a nice documentation.

.. tip::

  The Onboarding is also part of our documentation. You can be find the source code \
  of this page at ``docs/content/onboarding/repository.rst``.


Init
----

The ``init/`` directory contains files and scripts to install \
and setup this repository.
You've already used the ``init/init.sh`` when following our installation guide.


Machine Learning
----------------

Interesting things happen in ``kitcar_ml/``.
Here, we write our machine learning code.
Let's take a closer look:

.. program-output::
  cd $KITCAR_REPO_PATH/kitcar-machine-learning && tree -I __pycache__ -L 2 --dirsfirst kitcar_ml
  :shell:

Models
^^^^^^

We have subdirectories in ``kitcar_ml/`` for each problem we want to solve with machine learning.

For example there is a folder ``kitcar_ml/traffic_sign_detection`` which \
contains our models for solving the traffic sign detection.

Within ``kitcar_ml/traffic_sign_detection`` there is a folder foreach \
model we have to solve the traffic sign detection.

Utils
^^^^^

Utils packages are located in ``kitcar_ml/utils``.

Onboarding
^^^^^^^^^^

Onboarding files and scripts are located in ``kitcar_ml/onboarding``.