@@ -352,3 +352,56 @@ Now you can scan your model and display your scan report:
352
352
scan_results = giskard.scan(giskard_model)
353
353
display(scan_results) # in your notebook
354
354
```
355
+
356
+ ``` {eval-rst}
357
+ .. include:: ./html.rst
358
+ ```
359
+
360
+ If you are not working in a notebook or want to save the results for later, you can save them to an HTML file like this:
361
+
362
+ ``` python
363
+ scan_results.to_html(" model_scan_results.html" )
364
+ ```
365
+
366
+ > #### 💡 Customize your scan
367
+ >
368
+ > Check our [ Advanced scan usage page] ( https://docs.giskard.ai/en/stable/open_source/scan/advanced_scan/index.html ) , if
369
+ > you want to:
370
+ >
371
+ > - Scan with only some ** specific detectors**
372
+ > - Make the scan ** faster**
373
+
374
+ ## What's next?
375
+
376
+ Your scan results may have highlighted important vulnerabilities. There are 2 important actions you can take next:
377
+
378
+ ### 1. Generate a test suite from your scan results to:
379
+
380
+ - Turn the issues you found into actionable tests that you can save and reuse in further iterations
381
+
382
+ ``` python
383
+ test_suite = scan_results.generate_test_suite(" My first test suite" )
384
+
385
+ # You can run the test suite locally to verify that it reproduces the issues
386
+ test_suite.run()
387
+ ```
388
+
389
+ Jump to the [ test customization] ( https://docs.giskard.ai/en/stable/open_source/customize_tests/index.html )
390
+ and [ test integration] ( https://docs.giskard.ai/en/stable/open_source/integrate_tests/index.html ) sections to find out
391
+ everything you can do with test suites.
392
+
393
+ ### 2. Run the test suite with a different model:
394
+
395
+ ``` python
396
+ # wrap a different model
397
+ giskard_model_2 = giskard.Model(... )
398
+
399
+ # run the test suite with the new model
400
+ test_suite.run(model = giskard_model_2)
401
+ ```
402
+
403
+ Check the [ test suite documentation] ( https://docs.giskard.ai/en/stable/reference/suite/index.html#giskard.Suite ) to learn more.
404
+
405
+ ## Troubleshooting
406
+
407
+ If you encounter any issues, join our [ Discord community] ( https://discord.gg/fkv7CAr3FE ) and ask questions in our #support channel.
0 commit comments