Overview
========

Our repository provides well-structured `APIs <https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding>`_ for the inference, evaluation, and fine-tuning of BGE series models.
Besides that, there are abundant resources of  and  for users to quickly get a hands-on experience.

.. figure:: https://raw.githubusercontent.com/FlagOpen/FlagEmbedding/refs/heads/master/imgs/projects.png
   :width: 700
   :align: center

   Structure of contents in our `repo <https://github.com/FlagOpen/FlagEmbedding>`_

Our repository provides well-structured contents for information retrieval and RAG:

- The core `APIs <../API>`_ for embedding models' inference, evaluation, and fine-tuning.
- Hands-on `examples <https://github.com/FlagOpen/FlagEmbedding/tree/master/examples>`_ for the three mentioned use cases.
- Detailed `tutorials <https://github.com/FlagOpen/FlagEmbedding/tree/master/Tutorials>`_ covering topics in retrieval to help you learn from scratch.