Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@julianmendez
julianmendez committed Feb 25, 2024
1 parent 182a40d commit ae1017e
Showing 1 changed file with 29 additions and 29 deletions.
58 changes: 29 additions & 29 deletions docs/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ written in [Soda](https://julianmendez.github.io/soda) and grouped in packages t

The fairness tiles are defined in
[package tile](
https://github.com/julianmendez/soda/tree/master/tiles/src/main/scala/soda/tiles/fairness/tile
https://github.com/julianmendez/tiles/tree/master/core/src/main/scala/soda/tiles/fairness/tile
) [(Scala translation)](
https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/Package.scala
https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/Package.scala
) and they use entities and other tools defined in
[package tool](
https://github.com/julianmendez/soda/tree/master/tiles/src/main/scala/soda/tiles/fairness/tool
https://github.com/julianmendez/tiles/tree/master/core/src/main/scala/soda/tiles/fairness/tool
) [(Scala translation)](
https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tool/Package.scala
https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tool/Package.scala
).


Expand All @@ -29,16 +29,16 @@ These are some of the implemented fairness tiles for resource allocation scenari

| Tile | Class |
|:-----------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|
| all-actor <sub>*(a)*</sub> | [AllActorTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AllActorTile.soda) |
| <sub>*(a)*</sub> received-&sigma;-p <sub>*(m)*</sub> | [ReceivedSigmaPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/ReceivedSigmaPTile.soda) |
| <sub>*(m)*</sub> all-equal <sub>*b*</sub> | [AllEqualTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AllEqualTile.soda) |
| <sub>*(a)*</sub> needed-p <sub>*(m)*</sub> | [NeededPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/NeededPTile.soda) |
| <sub>*(m0, m1)*</sub> at-least <sub>*b*</sub> | [AtLeastTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AtLeastTile.soda) |
| equality <sub>*b*</sub> | [EqualityTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/EqualityTile.soda) |
| equity <sub>*b*</sub> | [EquityTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/EquityTile.soda) |
| all-actor <sub>*(a)*</sub> | [AllActorTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllActorTile.soda) |
| <sub>*(a)*</sub> received-&sigma;-p <sub>*(m)*</sub> | [ReceivedSigmaPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/ReceivedSigmaPTile.soda) |
| <sub>*(m)*</sub> all-equal <sub>*b*</sub> | [AllEqualTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllEqualTile.soda) |
| <sub>*(a)*</sub> needed-p <sub>*(m)*</sub> | [NeededPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/NeededPTile.soda) |
| <sub>*(m0, m1)*</sub> all-at-least <sub>*b*</sub> | [AllAtLeastTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllAtLeastTile.soda) |
| equality <sub>*b*</sub> | [EqualityPipeline](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/pipeline/EqualityPipeline.soda) |
| equity <sub>*b*</sub> | [EquityPipeline](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/pipeline/EquityPipeline.soda) |

A specific scenario is given as an example in [ResourceAllocationScenarioExample](https://github.com/julianmendez/soda/blob/master/tiles/src/test/scala/soda/tiles/fairness/tile/ResourceAllocationScenarioExample.soda).
This scenario is used to test the equality tile with [EqualityTileSpec](https://github.com/julianmendez/soda/blob/master/tiles/src/test/scala/soda/tiles/fairness/tile/EqualityTileSpec.soda) and the equity tile with [EquityTileSpec](https://github.com/julianmendez/soda/blob/master/tiles/src/test/scala/soda/tiles/fairness/tile/EquityTileSpec.soda).
A specific scenario is given as an example in [ResourceAllocationScenarioExample](https://github.com/julianmendez/tiles/blob/master/core/src/test/scala/soda/tiles/fairness/pipeline/ResourceAllocationScenarioExample.soda).
This scenario is used to test the equality tile with [EqualityPipelineSpec](https://github.com/julianmendez/tiles/blob/master/core/src/test/scala/soda/tiles/fairness/pipeline/EqualityPipelineSpec.soda) and the equity tile with [EquityTileSpec](https://github.com/julianmendez/tiles/blob/master/core/src/test/scala/soda/tiles/fairness/tile/EquityTileSpec.soda).


#### Equality
Expand Down Expand Up @@ -67,18 +67,18 @@ These are some of the implemented fairness tiles for scoring scenarios:

| Tile | Class |
|:-------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------|
| all-actor <sub>*(a0, a1, a2)*</sub> | [AllActorTripleTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AllActorTripleTile.soda) |
| <sub>*(a)*</sub> prediction-p <sub>*(m)*</sub> | [PredictionPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/PredictionPTile.soda) |
| <sub>*(a)*</sub> result-p <sub>*(m)*</sub> | [ResultPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/ResultPTile.soda) |
| <sub>*(m0, m1)*</sub> false-pos <sub>*(m)*</sub> | [FalsePosTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) |
| <sub>*(a)*</sub> with-p <sub>*(m)*</sub> | [WithPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/WithPTile.soda) |
| <sub>*(m0, m1)*</sub> correlation <sub>*m*</sub> | [CorrelationTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/CorrelationTile.soda) |
| <sub>*m*</sub> decision <sub>*b*</sub> | [DecisionTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/DecisionTile.soda) |
| unbiasedness <sub>*b*</sub> | [UnbiasednessTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/UnbiasednessTile.soda) |

A specific scenario is given as an example in [ScoringScenarioExample](https://github.com/julianmendez/soda/blob/master/tiles/src/test/scala/soda/tiles/fairness/tile/ScoringScenarioExample.soda).
| all-actor <sub>*(a0, a1, a2)*</sub> | [AllActorTripleTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllActorTripleTile.soda) |
| <sub>*(a)*</sub> prediction-p <sub>*(m)*</sub> | [PredictionPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/PredictionPTile.soda) |
| <sub>*(a)*</sub> result-p <sub>*(m)*</sub> | [ResultPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/ResultPTile.soda) |
| <sub>*(m0, m1)*</sub> false-pos <sub>*(m)*</sub> | [FalsePosTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) |
| <sub>*(a)*</sub> with-p <sub>*(m)*</sub> | [WithPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/WithPTile.soda) |
| <sub>*(m0, m1)*</sub> correlation <sub>*m*</sub> | [CorrelationTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/CorrelationTile.soda) |
| <sub>*m*</sub> decision <sub>*b*</sub> | [DecisionTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/DecisionTile.soda) |
| unbiasedness <sub>*b*</sub> | [UnbiasednessTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/pipeline/UnbiasednessPipeline.soda) |

A specific scenario is given as an example in [ScoringScenarioExample](https://github.com/julianmendez/tiles/blob/master/core/src/test/scala/soda/tiles/fairness/tile/ScoringScenarioExample.soda).
This scenario is used to test the scoring scenario tile (unbiasedness with respect to false positives) with
[UnbiasednessTileSpec](https://github.com/julianmendez/soda/blob/master/tiles/src/test/scala/soda/tiles/fairness/tile/UnbiasednessTileSpec.soda).
[UnbiasednessPipelineSpec](https://github.com/julianmendez/tiles/blob/master/core/src/test/scala/soda/tiles/fairness/pipeline/UnbiasednessPipelineSpec.soda).


#### Unbiasedness
Expand All @@ -103,11 +103,11 @@ are:

| Tile | Class |
|:-------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
| <sub>*(a)*</sub> attribute-p <sub>*(m)*</sub> | [AttributePTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AttributePTile.soda) |
| <sub>*(m0, m1)*</sub> &sigma;-p <sub>*(m)*</sub> | [SigmaTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) |
| <sub>*(&alpha;0) (&alpha;1)*</sub> zip <sub>*(&alpha;0, &alpha;1)*</sub> | [ZipTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/ZipTile.soda) |
| <sub>*(&alpha;0, &alpha;1)*</sub> unzip-0 <sub>*(&alpha;0)*</sub> | [UnzipPairFstTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/UnzipPairTile.soda) |
| <sub>*(&alpha;0, &alpha;1)*</sub> unzip-1 <sub>*(&alpha;1)*</sub> | [UnzipPairSndTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/UnzipPairTile.soda) |
| <sub>*(a)*</sub> attribute-p <sub>*(m)*</sub> | [AttributePTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AttributePTile.soda) |
| <sub>*(m0, m1)*</sub> &sigma;-p <sub>*(m)*</sub> | [SigmaTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) |
| <sub>*(&alpha;0) (&alpha;1)*</sub> zip <sub>*(&alpha;0, &alpha;1)*</sub> | [ZipTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/ZipTile.soda) |
| <sub>*(&alpha;0, &alpha;1)*</sub> unzip-0 <sub>*(&alpha;0)*</sub> | [UnzipPairFstTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/UnzipPairFstTile.soda) |
| <sub>*(&alpha;0, &alpha;1)*</sub> unzip-1 <sub>*(&alpha;1)*</sub> | [UnzipPairSndTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/UnzipPairSndTile.soda) |

<script>
window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid'));
Expand Down

0 comments on commit ae1017e

Please sign in to comment.