File size: 4,110 Bytes
ee037e9 a7431bb ee037e9 5574116 ee037e9 a7431bb ee037e9 a7431bb ee037e9 a7431bb ee037e9 a7431bb ee037e9 a7431bb ee037e9 a7431bb c344c74 a7431bb ee037e9 a7431bb c344c74 a7431bb ee037e9 a7431bb ee037e9 a7431bb c344c74 a7431bb |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
---
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, 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
```
|