.. Bigscity-LibCity documentation master file, created by
   sphinx-quickstart on Sat Dec 26 22:20:09 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Bigscity-LibCity's documentation!
=================================================
   
.. toctree::
   :maxdepth: 1
   :caption: Get Started

   get_started/introduction
   get_started/install
   get_started/quick_start
   get_started/directory_structure

.. toctree::
   :maxdepth: 1
   :caption: User Guide

   user_guide/config_settings
   user_guide/data
   user_guide/model
   user_guide/evaluator
   user_guide/executor
   user_guide/logger
   user_guide/usage

.. toctree::
   :maxdepth: 1
   :caption: Developer Guide

   developer_guide/code_style
   developer_guide/implemented_datasets
   developer_guide/implemented_models
   developer_guide/implemented_executors

.. toctree::
   :maxdepth: 1
   :caption: Tutorial
   
   tutorial/install_quick_start
   tutorial/run_model
   tutorial/add_model
   tutorial/hyper_tune
   tutorial/data_visualization

.. toctree::
   :maxdepth: 1
   :caption: API REFERENCE

   libcity/libcity.config
   libcity/libcity.data
   libcity/libcity.evaluator
   libcity/libcity.executor
   libcity/libcity.model
   libcity/libcity.pipeline
   libcity/libcity.utils

Indices and tables
==================

* :ref:`genindex`
* :ref:`search`