Skip to content

Commit

Permalink
updated landing page text
Browse files Browse the repository at this point in the history
  • Loading branch information
AndreFCruz committed Oct 31, 2024
1 parent 77333a6 commit e3639d5
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,21 +12,22 @@
Welcome to :code:`folktexts`' documentation!
============================================

The :code:`folktexts` package enables you to benchmark and evaluate LLMs as risk
scores.
The :code:`folktexts` package enables you to benchmark and evaluate
LLM-generated risk scores.

We encode unrealizable tabular prediction tasks as natural-language text,
and prompt LLMs for the probability of target variable being true.
We encode unrealizable tabular prediction tasks as natural language text tasks,
and prompt LLMs for the probability of a target variable being true.
The correct solutions for each task often require expressing uncertainty, as the
target variable is not uniquely determined by the input features.

Folktexts is compatible with any huggingface transformer model.
Folktexts is compatible with any huggingface transformer model and models
available through web APIs (e.g., OpenAI API).

Five tabular data tasks are provided out-of-the-box, using the American
Community Survey as a data source: `ACSIncome`, `ACSMobility`, `ACSTravelTime`,
`ACSEmployment`, and `ACSPublicCoverage`. These tasks follow the same name, feature
columns, and target columns as those put forth by `Ding et al. (2021)`_ in the
`folktables`_ python package.
`ACSEmployment`, and `ACSPublicCoverage`. These tasks follow the same name,
feature columns, and target columns as those put forth by `Ding et al. (2021)`_
in the `folktables`_ python package.


Full code available on the `GitHub repository`_,
Expand Down

0 comments on commit e3639d5

Please sign in to comment.