index.rst

Welcome to the VLMEvalKit Tutorial!
==========================================

VLMEvalKit Getting Started Guide
-------------------------------

To help users get started quickly, we recommend the following process:

- For users who want to use VLMEvalKit, we recommend reading the "Start Your First Step" section to set up the environment and start a mini-experiment to familiarize yourself with the process.

- If you want to customize more modules, such as adding datasets and models, we provide an "Advanced Tutorial."

We always welcome users' PRs (Pull Requests) and Issues to improve VLMEvalKit!

.. _Start Your First Step:
.. toctree::
   :maxdepth: 1
   :caption: Start Your First Step

   get_started/Quickstart.md


.. .. _Tutorials:
.. .. toctree::
..    :maxdepth: 1
..    :caption: Tutorials

..    user_guides/framework_overview.md

.. _Advanced Tutorial:
.. toctree::
   :maxdepth: 1
   :caption: Advanced Tutorial

   advanced_guides/Development.md

.. .. _Other Notes:
.. .. toctree::
..    :maxdepth: 1
..    :caption: Other Notes

..    notes/contribution_guide.md

Index and Tables
==================

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