Skip to content

Documentation: Add the list of tags available for the only param of the scan method #1984

@kevinmessiaen

Description

@kevinmessiaen

🚀 Feature Request

Add the list of tags available for the only param of the scan method in the documentation.

🔈 Motivation

The only parameter accept a List[str] but it is undocumented. Therefore to know what tags to put we have to investigate the detectors source code.

🛰 Alternatives

Add a method to dynamically list the detectors and tags in Giskard: giskard.list_detectors()

📎 Additional context

Detectors are registered using the @detector decorator
see here: https://github.com/Giskard-AI/giskard/blob/f68a495ef1df470d55790fa7c2308303881e30d6/giskard/scanner/llm/llm_chars_injection_detector.py#L14

The tags parameters allow to only run specific detectors when using giskard.scan(model, dataset, only=['list', 'of', 'tags']), the rule is to run only the detectors that contains at least one tag included in the only list.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions