Skip to content

Commit

Permalink
Update README.md (#2)
Browse files Browse the repository at this point in the history
* Update README.md

rename and paraphrase feature descriptions
  • Loading branch information
yilin-geng authored Apr 4, 2024
1 parent 0e9afbc commit 4e6b47d
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
<br />
</div>

# OpenFactVerification: An Open-source Tool for Fact Verification
# Loki: An Open-source Tool for Fact Verification

## Overview
OpenFactChecking is our open-source solution designed to automate the process of verifying factuality. It provides a comprehensive pipeline for dissecting long texts into individual claims, assessing their worthiness for verification, generating queries for evidence search, crawling for evidence, and ultimately verifying the claims. This tool is especially useful for journalists, researchers, and anyone interested in the factuality of information. To stay updated, please subscribe to our newsletter at [our website](https://www.librai.tech/) or join us on [Discord](https://discord.gg/NRge6RS7)!
Loki is our open-source solution designed to automate the process of verifying factuality. It provides a comprehensive pipeline for dissecting long texts into individual claims, assessing their worthiness for verification, generating queries for evidence search, crawling for evidence, and ultimately verifying the claims. This tool is especially useful for journalists, researchers, and anyone interested in the factuality of information. To stay updated, please subscribe to our newsletter at [our website](https://www.librai.tech/) or join us on [Discord](https://discord.gg/NRge6RS7)!

## Components
- **Decomposer:** Splits a long text into several independent claims for further processing.
- **Checkworthy:** Evaluates each claim to determine if it's worth checking. For example, vague claims like "MBZUAI has a vast campus" are considered unworthy because of the ambiguous nature of "vast."
- **Query Generator:** For each check-worthy claim, generates queries to search for evidence on search engines, aiding in the validation of the claim's authenticity.
- **Evidence Crawler:** Uses search engines to find evidence based on the queries generated, collecting results for analysis.
- **ClaimVerify:** Analyzes the search results to ascertain the accuracy of the claims.
- **Decomposer:** Breaks down extensive texts into digestible, independent claims, setting the stage for detailed analysis.
- **Checkworthy:** Assesses each claim's potential significance, filtering out vague or ambiguous statements to focus on those that truly matter. For example, vague claims like "MBZUAI has a vast campus" are considered unworthy because of the ambiguous nature of "vast."
- **Query Generator:** Transforms check-worthy claims into precise queries, ready to navigate the vast expanse of the internet in search of truth.
- **Evidence Crawler:** Ventures into the digital realm, retrieving relevant evidence that forms the foundation of informed verification.
- **ClaimVerify:** Examines the gathered evidence, determining the veracity of each claim to uphold the integrity of information.

## Quick Start
### Prerequisites
Expand Down Expand Up @@ -156,12 +156,12 @@ add slack channel here

## Cite as
```
@misc{openfactverification,
@misc{Loki,
author = {Wang, Hao and Wang, Yuxia and Wang, Minghan and Geng, Yilin and Zhao, Zhen and Zhai, Zenan and Han, Xudong and Li, Haonan},
title = {OpenFactVerification: An Open-source Tool for Fact Verification},
title = {Loki: An Open-source Tool for Fact Verification},
year = {2024},
publisher = {GitHub},
journal = {GitHub repository},
howpublished = {\url{https://github.com/Libr-AI/OpenFactVerification}},
howpublished = {\url{https://github.com/Libr-AI/Loki}},
}
```
8 changes: 3 additions & 5 deletions factcheck/config/secret_dict.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
import os

serper_dict = {"default_key": "2608ec01b06e07513e83b4b0a0e758dfb100d635"}
openai_dict = {"default_key": "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"}
serper_dict = {"default_key": None}
openai_dict = {"default_key": None}
anthropic_dict = {"default_key": None}

serper_dict["key"] = os.environ.get("SERPER_API_KEY", serper_dict["default_key"])
openai_dict["key"] = os.environ.get("OPENAI_API_KEY", openai_dict["default_key"])
anthropic_dict["key"] = os.environ.get(
"ANTHROPIC_API_KEY", anthropic_dict["default_key"]
)
anthropic_dict["key"] = os.environ.get("ANTHROPIC_API_KEY", anthropic_dict["default_key"])

0 comments on commit 4e6b47d

Please sign in to comment.