feat(Update docs):

This commit is contained in:
Alexander Myasoedov
2025-01-25 12:28:50 +02:00
parent 9817ab495a
commit 50436e1f1d
13 changed files with 334 additions and 415 deletions
+8
View File
@@ -5,6 +5,7 @@ The `probe_data` module is a core component of the Agentic Security project, res
## Files and Key Components
### audio_generator.py
- **Functions:**
- `encode(content: bytes) -> str`: Encodes audio content to a string format.
- `generate_audio_mac_wav(prompt: str) -> bytes`: Generates audio in WAV format for macOS.
@@ -13,6 +14,7 @@ The `probe_data` module is a core component of the Agentic Security project, res
- `RequestAdapter`: Handles requests for audio generation.
### data.py
- **Functions:**
- `load_dataset_general(...)`: Loads datasets with general specifications.
- `count_words_in_list(str_list)`: Counts words in a list of strings.
@@ -21,6 +23,7 @@ The `probe_data` module is a core component of the Agentic Security project, res
- `Stenography`: Applies transformations to prompt groups.
### image_generator.py
- **Functions:**
- `generate_image_dataset(...)`: Generates a dataset of images.
- `generate_image(prompt: str) -> bytes`: Generates an image from a prompt.
@@ -28,17 +31,20 @@ The `probe_data` module is a core component of the Agentic Security project, res
- `RequestAdapter`: Handles requests for image generation.
### models.py
- **Classes:**
- `ProbeDataset`: Represents a dataset for probing.
- `ImageProbeDataset`: Extends `ProbeDataset` for image data.
### msj_data.py
- **Functions:**
- `load_dataset_generic(...)`: Loads a generic dataset.
- **Classes:**
- `ProbeDataset`: Represents a dataset for probing.
### stenography_fn.py
- **Functions:**
- `rot13(input_text)`: Applies ROT13 transformation.
- `base64_encode(data)`: Encodes data in base64 format.
@@ -47,6 +53,7 @@ The `probe_data` module is a core component of the Agentic Security project, res
## Usage Examples
### Generating Audio
```python
from agentic_security.probe_data.audio_generator import generate_audioform
@@ -54,6 +61,7 @@ audio_bytes = generate_audioform("Hello, world!")
```
### Loading a Dataset
```python
from agentic_security.probe_data.data import load_dataset_general