From ae1017e4b80f7f1724f5437106ea31151e90c874 Mon Sep 17 00:00:00 2001 From: Julian Mendez Date: Sun, 25 Feb 2024 20:17:43 +0100 Subject: [PATCH] Update README.md --- docs/README.md | 58 +++++++++++++++++++++++++------------------------- 1 file changed, 29 insertions(+), 29 deletions(-) diff --git a/docs/README.md b/docs/README.md index 77f37f9..3331ece 100644 --- a/docs/README.md +++ b/docs/README.md @@ -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 ). @@ -29,16 +29,16 @@ These are some of the implemented fairness tiles for resource allocation scenari | Tile | Class | |:-----------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| -| all-actor *(a)* | [AllActorTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AllActorTile.soda) | -| *(a)* received-σ-p *(m)* | [ReceivedSigmaPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/ReceivedSigmaPTile.soda) | -| *(m)* all-equal *b* | [AllEqualTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AllEqualTile.soda) | -| *(a)* needed-p *(m)* | [NeededPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/NeededPTile.soda) | -| *(m0, m1)* at-least *b* | [AtLeastTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AtLeastTile.soda) | -| equality *b* | [EqualityTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/EqualityTile.soda) | -| equity *b* | [EquityTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/EquityTile.soda) | +| all-actor *(a)* | [AllActorTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllActorTile.soda) | +| *(a)* received-σ-p *(m)* | [ReceivedSigmaPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/ReceivedSigmaPTile.soda) | +| *(m)* all-equal *b* | [AllEqualTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllEqualTile.soda) | +| *(a)* needed-p *(m)* | [NeededPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/NeededPTile.soda) | +| *(m0, m1)* all-at-least *b* | [AllAtLeastTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllAtLeastTile.soda) | +| equality *b* | [EqualityPipeline](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/pipeline/EqualityPipeline.soda) | +| equity *b* | [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 @@ -67,18 +67,18 @@ These are some of the implemented fairness tiles for scoring scenarios: | Tile | Class | |:-------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------| -| all-actor *(a0, a1, a2)* | [AllActorTripleTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AllActorTripleTile.soda) | -| *(a)* prediction-p *(m)* | [PredictionPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/PredictionPTile.soda) | -| *(a)* result-p *(m)* | [ResultPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/ResultPTile.soda) | -| *(m0, m1)* false-pos *(m)* | [FalsePosTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) | -| *(a)* with-p *(m)* | [WithPTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/WithPTile.soda) | -| *(m0, m1)* correlation *m* | [CorrelationTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/CorrelationTile.soda) | -| *m* decision *b* | [DecisionTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/DecisionTile.soda) | -| unbiasedness *b* | [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 *(a0, a1, a2)* | [AllActorTripleTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AllActorTripleTile.soda) | +| *(a)* prediction-p *(m)* | [PredictionPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/PredictionPTile.soda) | +| *(a)* result-p *(m)* | [ResultPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/ResultPTile.soda) | +| *(m0, m1)* false-pos *(m)* | [FalsePosTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) | +| *(a)* with-p *(m)* | [WithPTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/WithPTile.soda) | +| *(m0, m1)* correlation *m* | [CorrelationTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/CorrelationTile.soda) | +| *m* decision *b* | [DecisionTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/DecisionTile.soda) | +| unbiasedness *b* | [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 @@ -103,11 +103,11 @@ are: | Tile | Class | |:-------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------| -| *(a)* attribute-p *(m)* | [AttributePTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/AttributePTile.soda) | -| *(m0, m1)* σ-p *(m)* | [SigmaTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) | -| *(α0) (α1)* zip *(α0, α1)* | [ZipTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/ZipTile.soda) | -| *(α0, α1)* unzip-0 *(α0)* | [UnzipPairFstTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/UnzipPairTile.soda) | -| *(α0, α1)* unzip-1 *(α1)* | [UnzipPairSndTile](https://github.com/julianmendez/soda/blob/master/tiles/src/main/scala/soda/tiles/fairness/tile/UnzipPairTile.soda) | +| *(a)* attribute-p *(m)* | [AttributePTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/AttributePTile.soda) | +| *(m0, m1)* σ-p *(m)* | [SigmaTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/FalsePosTile.soda) | +| *(α0) (α1)* zip *(α0, α1)* | [ZipTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/ZipTile.soda) | +| *(α0, α1)* unzip-0 *(α0)* | [UnzipPairFstTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/UnzipPairFstTile.soda) | +| *(α0, α1)* unzip-1 *(α1)* | [UnzipPairSndTile](https://github.com/julianmendez/tiles/blob/master/core/src/main/scala/soda/tiles/fairness/tile/UnzipPairSndTile.soda) |