Skip to content

Commit fcb3843

Browse files
Merge branch 'main' into GSK-2617
2 parents cdeb1f0 + 86a8a59 commit fcb3843

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<p align="center">
2-
<img alt="giskardlogo" src="readme/giskard_logo.png#gh-light-mode-only">
3-
<img alt="giskardlogo" src="readme/giskard_logo_green.png#gh-dark-mode-only">
2+
<img alt="giskardlogo" src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/giskard_logo.png#gh-light-mode-only">
3+
<img alt="giskardlogo" src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/giskard_logo_green.png#gh-dark-mode-only">
44
</p>
55
<h1 align="center" weight='300' >The testing framework dedicated to ML models, from tabular to LLMs</h1>
66
<h3 align="center" weight='300' >Scan AI models to detect risks of biases, performance issues and errors. In 4 lines of code. </h3>
@@ -36,28 +36,28 @@ We officially support Python 3.9, 3.10 and 3.11.
3636
______________________________________________________________________
3737

3838
<p align="center">
39-
<img src="readme/architechture_giskard.png" alt="Giskard Architechture" width="800">
39+
<img src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/architechture_giskard.png" alt="Giskard Architechture" width="800">
4040
</p>
4141

4242
Giskard is a Python library that automatically **detects vulnerabilities** in AI models, from tabular models to LLM, including performance biases, data leakage, spurious correlation, hallucination, toxicity, security issues and many more.
4343

4444
It's a powerful tool that helps data scientists **save time and effort** drilling down on model issues, and produce more **reliable and trustworthy models**.
4545

4646
<p align="center">
47-
<img src="readme/scan_example.gif" alt="Scan Example" width="800">
47+
<img src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/scan_example.gif" alt="Scan Example" width="800">
4848
</p>
4949

5050
Instantaneously generate test suites for your models ⤵️
5151

5252
<p align="center">
53-
<img src="readme/suite_example.png" alt="Test Suite Example" width="800">
53+
<img src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/suite_example.png" alt="Test Suite Example" width="800">
5454
</p>
5555

5656

5757
Giskard works with any model, in any environment and integrates seamlessly with your favorite tools ⤵️ <br/>
5858

5959
<p align="center">
60-
<img width='600' src="readme/tools.png">
60+
<img width='600' src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/tools.png">
6161
</p>
6262
<br/>
6363

@@ -143,7 +143,7 @@ The Giskard hub is Giskard's premium offering. It provides a number of additiona
143143
If you are interested in learning more about Giskard's premium offering, please [contact us](https://www.giskard.ai/contact).
144144

145145
<p align="center">
146-
<img src="readme/catalog_example.png" alt="Scan Example" width="700px">
146+
<img src="https://raw.githubusercontent.com/giskard-ai/giskard/main/readme/catalog_example.png" alt="Scan Example" width="700px">
147147
</p>
148148

149149
## 1. Start the Giskard hub

docs/giskard_hub/write_and_debug_tests/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To add tests from the catalog, click on "add test" in your test suite tab. This
3434
catalog showing all Giskard tests. You then have the possibility to run your test before adding it to your suite.
3535

3636
> ⚠️ Warning
37-
> * If you add a test **without** specifying the input of your test, you'll be asked to define the input at **suite execution time**. This input will become a *suite input*. Models are a great suite input to [compare different model](../compare_models/index.md) with the same test suite.
37+
> * If you add a test **without** specifying the input of your test, you'll be asked to define the input at **suite execution time**. This input will become a *suite input*. Models are a great suite input to [compare different models](../compare_models/index.md) with the same test suite.
3838
> * If you add a test by **specifying the input** of your test, you won't be asked to define it at suite
3939
> execution time. This input becomes a *fixed value* of your suite. Data slices or thresholds are
4040
> great fixed values because they are inherent to your suite.

docs/integrations/pytest/index.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@
99
```
1010

1111

12-
It is possible to execute Giskard test via pytest with very minimal code. Using pytest to execute tests can facilitate the integration with CI/CD scripts and leverage builtin functionalities like test report or advanced markings (xfail, skip).
12+
It is possible to execute Giskard tests via pytest with very minimal code. Using pytest to execute tests can facilitate the integration with CI/CD scripts and leverage builtin functionalities like test report or advanced markings (xfail, skip).
1313

14-
Once define in a script, the execution of the tests can be triggred using the pytest command:
14+
Once defined in a script, the execution of the tests can be triggered using the pytest command:
1515

1616
```console
1717
$ pytest test_ml_model.py

docs/open_source/scan/scan_llm/index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,7 @@ Jump to the [test customization](https://docs.giskard.ai/en/latest/open_source/c
250250

251251
### 2. Upload your test suite to the Giskard Hub to:
252252
* Compare the quality of different models and prompts to decide which one to promote
253-
* Create more tests relevant to your use case, combining input prompts that make your model fail and custome evaluation criteria
253+
* Create more tests relevant to your use case, combining input prompts that make your model fail and custom evaluation criteria
254254
* Share results, and collaborate with your team to integrate business feedback
255255

256256
To upload your test suite, you must have created a project on Giskard Hub and instantiated a Giskard Python client. If you haven't done this yet, follow the first steps of [upload your object](https://docs.giskard.ai/en/latest/giskard_hub/upload/index.html#upload-your-object) guide.

0 commit comments

Comments
 (0)