minor doc enhancements

mever-team · May 17, 2024 · f9d3e2e · f9d3e2e
1 parent 0129e9f
commit f9d3e2e
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,7 @@ Visit one of the links below, or read the full documentation.
 <div style="display: flex; flex-wrap: wrap; gap: 10px;" markdown="span">
 
   <a href="quickstart/" style="border: 1px solid black; padding: 10px; flex: 1; text-align: center;" markdown="span">
-    <span style="font-size: 250%"> :rocket: </span><br>**Quickstart**<br> New? Start here.
+    <span style="font-size: 250%"> :rocket: </span><br>**Quickstart**<br> New to the library? Start here.
   </a>
 
   <a href="basics/forks/" style="border: 1px solid black; padding: 10px; flex: 1; text-align: center;" markdown="span">

diff --git a/docs/quickstart.md b/docs/quickstart.md
@@ -27,7 +27,7 @@ import fairbench as fb
 test, y, yhat = fb.demos.adult()  # test is a Pandas dataframe
 ```
 
-## 2. Create a sensitive attribute [fork](basics/forks.md)
+## 2. Set    sensitive attribute [fork](basics/forks.md)
 
 Pack sensitive attributes found in your test data
 into a data structure called fork.
@@ -40,7 +40,7 @@ sensitive = fb.Fork(fb.categories @ test[8], fb.categories @ test[9])  # analyse
 sensitive = sensitive.intersectional()  # automatically find non-empty intersections
 ```
 
-## 3. Create and explore fairness [reports](basics/reports.md)
+## 3. Explore fairness [reports](basics/reports.md)
 
 Use sensitive attribute forks alongside predictions 
 to generate fairness reports.

diff --git a/docs/record/comparisons.md b/docs/record/comparisons.md
@@ -1,9 +1,9 @@
 # Metric comparisons
 
 In FairBench [reports](../basics/reports.md) you will see 
-several comparison mechanisms of base metrics that include expansions
-and reductions. Here we summarize those mechanisms based on
-how they appear as column titles in generated reports.
+several comparison mechanisms of [base metrics](metrics.md) that include expansions
+and reductions. Here we summarize the mechanisms that
+appear as column titles of the in-built report methods.
 
 ### `min`
 <div class="doc" markdown="span">

diff --git a/docs/record/metrics.md b/docs/record/metrics.md
@@ -1,4 +1,4 @@
-# Performance metrics
+# Base metrics
 
 FairBench [reports](../basics/reports.md) 
 implement several definitions of fairness that