docs/src/index.md

---
myst:
  html_meta:
    "description lang=en": |
      Top-level documentation for openfactcheck, with links to the rest
      of the site..
html_theme.sidebar_secondary.remove: true
---

# OpenFactCheck Documentation

```{eval-rst}
.. module:: openfactcheck
```

OpenFactCheck is an open source, Apache-licensed library designed to facilitate the evaluation and enhancement of factuality in responses generated by large language models (LLMs).

The design of {mod}`openfactcheck` emphasizes two principles:

- Customizability and extensibility for both users and developers
- Compatibility with existing methods and datasets

It consists of three core modules:

```{gallery-grid}
:grid-columns: 1 1 2 3

- header: "{fas}`check-to-slot;pst-color-primary`  Response Evaluator"
  content: "Customizes an automatic fact-checker to verify free-form documents, providing detailed reports on the factuality of the responses."
- header: "{fas}`chart-line;pst-color-primary`  LLM Evaluator"
  content: "Applies factuality-specific benchmarks to assess the factual performance of large language models, providing detailed reports on the factuality of the responses."
- header: "{fas}`trophy;pst-color-primary`  Fact Checker Evaluator"
  content: "Evaluates fact-checking accuracy, featuring a leaderboard that ranks systems by precision, speed, and cost, driving innovation in automatic fact-checking."
```

Explore the documentation to learn more about the library, its features, how to use and contribute to it, and more.

```{warning}
The API and documentation are still under heavy development and may change in future versions.
```

```{eval-rst}
.. grid:: 1 2 2 2
    :gutter: 4
    :padding: 2 2 0 0
    :class-container: sd-text-center

    .. grid-item-card:: Getting Started
        :img-top: _static/index_getting_started.svg
        :class-card: intro-card
        :shadow: md

        New to *OpenFactCheck*? Check out the getting started guides. They contain an
        introduction to *OpenFactCheck*'s main concepts and links to additional tutorials.

        +++
        
        .. button-ref:: getting_started/index
            :ref-type: doc
            :color: secondary
            :expand:

            Begin Your Journey

    .. grid-item-card::  User Guide
        :img-top: _static/index_user_guide.svg
        :class-card: intro-card
        :shadow: md

        The user guide provides in-depth information on the
        key concepts of *OpenFactCheck* with useful background information and explanation.

        +++

        .. button-ref:: user_guide/index
            :ref-type: doc
            :color: secondary
            :expand:

            View User Guide

    .. grid-item-card::  API Reference
        :img-top: _static/index_api.svg
        :class-card: intro-card
        :shadow: md

        The reference guide contains a detailed description of
        the *OpenFactCheck* API. The reference describes how the methods work and which parameters can
        be used. It assumes that you have an understanding of the key concepts.

        +++

        .. button-ref:: reference/index
            :ref-type: doc
            :color: secondary
            :expand:

            View API Reference

    .. grid-item-card::  Developer Guide
        :img-top: _static/index_contribute.svg
        :class-card: intro-card
        :shadow: md

        Want to improve existing functionalities? Saw a typo in the documentation?
        Want to contribute to the project? The contributing guidelines will guide
        you through the process of improving *OpenFactCheck*.

        +++

        .. button-ref:: development/index
            :ref-type: doc
            :color: secondary
            :expand:

            Contribute
```

**Useful links**:
[Binary Installers](https://pypi.org/project/openfactcheck) |
[Source Repository](https://github.com/hasaniqbal777/openfactcheck) |
[Issues & Ideas](https://github.com/hasaniqbal777/openfactcheck/issues) |

```{toctree}
:hidden: true
:maxdepth: 3
:titlesonly: true

getting_started/index
user_guide/index
reference/index
development/index
```