Skip to content

Commit

Permalink
Merge pull request #41 from biaslyze-dev/0.1_text_update
Browse files Browse the repository at this point in the history
changed the api-text
  • Loading branch information
SLohmueller authored Aug 25, 2023
2 parents 428b518 + 9d5dbd5 commit 3d27fd1
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/sources/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ The `CounterfactualBiasDetector` class is at the heart of the biaslyze package,

## Results: CounterfactualDetectionResult

After running bias detection using the `CounterfactualBiasDetector`, the `CounterfactualDetectionResult` class is used to capture and present the results. This class provides comprehensive information about the detected biases, such as the identified biased concepts, the generated counterfactual examples, and most importantly, visualizations of the results. This facilitates a deeper understanding of the biases present in the analyzed text.
After running bias detection using the `CounterfactualBiasDetector`, the `CounterfactualDetectionResult` class is used to capture and present the results. This class provides comprehensive information about the models bias analysis, giving pointers to potentially biased concepts, the generated counterfactual examples, and most importantly, visualizations of the results. This facilitates a deeper understanding of the sensitive concepts present in the analyzed text.

## Concepts

The `Concept` class defines the fundamental building block for bias analysis in the biaslyze package. Concepts represent specific terms, phrases, or ideas related to protected attributes that might be affected by bias. These can be predefined concepts, or users can define their own based on the context of their analysis.
The `Concept` class defines the fundamental building block for bias analysis in the biaslyze package. Concepts represent specific terms, phrases, or ideas related to protected attributes that might be affected by bias and discrimination. These can be predefined concepts, or users can define their own based on the context of their analysis.


## Concept Detectors
Expand Down
4 changes: 2 additions & 2 deletions docs/templates/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ The `CounterfactualBiasDetector` class is at the heart of the biaslyze package,

## Results: CounterfactualDetectionResult

After running bias detection using the `CounterfactualBiasDetector`, the `CounterfactualDetectionResult` class is used to capture and present the results. This class provides comprehensive information about the detected biases, such as the identified biased concepts, the generated counterfactual examples, and most importantly, visualizations of the results. This facilitates a deeper understanding of the biases present in the analyzed text.
After running bias detection using the `CounterfactualBiasDetector`, the `CounterfactualDetectionResult` class is used to capture and present the results. This class provides comprehensive information about the models bias analysis, giving pointers to potentially biased concepts, the generated counterfactual examples, and most importantly, visualizations of the results. This facilitates a deeper understanding of the sensitive concepts present in the analyzed text.

## Concepts

The `Concept` class defines the fundamental building block for bias analysis in the biaslyze package. Concepts represent specific terms, phrases, or ideas related to protected attributes that might be affected by bias. These can be predefined concepts, or users can define their own based on the context of their analysis.
The `Concept` class defines the fundamental building block for bias analysis in the biaslyze package. Concepts represent specific terms, phrases, or ideas related to protected attributes that might be affected by bias and discrimination. These can be predefined concepts, or users can define their own based on the context of their analysis.


## Concept Detectors
Expand Down

0 comments on commit 3d27fd1

Please sign in to comment.