Skip to content

Commit

Permalink
update README, add folktexts diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreFCruz committed Nov 29, 2024
1 parent 2086cde commit 97f02d9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,20 +17,24 @@ on unrealizable tasks.

The `folktexts` python package enables computing and evaluating classification _risk scores_ for tabular prediction tasks using LLMs.

<!-- ![folktexts-diagram](docs/_static/folktexts-loop-diagram.png) -->
<p align="center">
<img src="docs/_static/folktexts-loop-diagram.png" alt="folktexts-diagram" width="700px">
</p>

Several benchmark tasks are provided based on data from the American Community Survey.
Namely, each tabular prediction task from the popular
[folktables](https://github.com/socialfoundations/folktables) package is made available
as a natural-language Q&A task.

Package documentation can be found [here](https://socialfoundations.github.io/folktexts/).

Parsed and ready-to-use versions of the *folktexts* datasets can be found on
Parsed and ready-to-use versions of each *folktexts* dataset can be found on
<a href="https://huggingface.co/datasets/acruz/folktexts">
<span style="display: inline-block; vertical-align: middle;">
<img src="https://huggingface.co/front/assets/huggingface_logo-noborder.svg" alt="Logo" style="height: 1em; vertical-align: text-bottom;">
</span>
Huggingface</a>.

Package documentation can be found [here](https://socialfoundations.github.io/folktexts/).

**Table of contents:**
- [Installing](#installing)
Expand Down
Binary file added docs/_static/folktexts-loop-diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 97f02d9

Please sign in to comment.