# API Reference

This section provides detailed API documentation for BRAID-DSPy.

```{toctree}
:maxdepth: 2

module
parser
generator
optimizer
signatures
```

## Core Classes

### BraidReasoning

Main module for BRAID reasoning in DSPy.

```{eval-rst}
.. autoclass:: braid.module.BraidReasoning
   :members:
   :undoc-members:
   :show-inheritance:
```

### BraidResult

Result object returned by BraidReasoning module.

```{eval-rst}
.. autoclass:: braid.module.BraidResult
   :members:
   :undoc-members:
```

## Parser

### MermaidParser

Parser for Mermaid flowchart diagrams.

```{eval-rst}
.. autoclass:: braid.parser.MermaidParser
   :members:
   :undoc-members:
   :show-inheritance:
```

### GRDStructure

Structure representing a parsed GRD.

```{eval-rst}
.. autoclass:: braid.parser.GRDStructure
   :members:
   :undoc-members:
```

## Generator

### GRDGenerator

Generator for Guided Reasoning Diagrams.

```{eval-rst}
.. autoclass:: braid.generator.GRDGenerator
   :members:
   :undoc-members:
   :show-inheritance:
```

## Optimizer

### BraidOptimizer

BRAID-aware optimizer for DSPy.

```{eval-rst}
.. autoclass:: braid.optimizer.BraidOptimizer
   :members:
   :undoc-members:
   :show-inheritance:
```

### GRDMetrics

Metrics for evaluating GRD quality.

```{eval-rst}
.. autoclass:: braid.optimizer.GRDMetrics
   :members:
   :undoc-members:
```

## Signatures

### BraidPlanSignature

Signature for GRD planning phase.

```{eval-rst}
.. autoclass:: braid.signatures.BraidPlanSignature
   :members:
   :undoc-members:
   :show-inheritance:
```

### BraidExecuteSignature

Signature for GRD execution phase.

```{eval-rst}
.. autoclass:: braid.signatures.BraidExecuteSignature
   :members:
   :undoc-members:
   :show-inheritance:
```

---

## BRAID Protocol Modules

### NumericalMasker

Prevents answer leakage by masking numerical values in GRDs.

```{eval-rst}
.. autoclass:: braid.masking.NumericalMasker
   :members:
   :undoc-members:
   :show-inheritance:
```

### AtomicityValidator

Validates node token density (≤15 tokens per node).

```{eval-rst}
.. autoclass:: braid.validators.AtomicityValidator
   :members:
   :undoc-members:
   :show-inheritance:
```

### ProceduralScaffoldingValidator

Validates procedural scaffolding and detects answer leakage.

```{eval-rst}
.. autoclass:: braid.validators.ProceduralScaffoldingValidator
   :members:
   :undoc-members:
   :show-inheritance:
```

### GRDValidator

Comprehensive GRD validator combining all checks.

```{eval-rst}
.. autoclass:: braid.validators.GRDValidator
   :members:
   :undoc-members:
   :show-inheritance:
```

### StatefulExecutionEngine

Dynamic GRD execution engine with state management.

```{eval-rst}
.. autoclass:: braid.engine.StatefulExecutionEngine
   :members:
   :undoc-members:
   :show-inheritance:
```

### CriticDetector

Identifies critic/verification nodes in GRDs.

```{eval-rst}
.. autoclass:: braid.critic.CriticDetector
   :members:
   :undoc-members:
   :show-inheritance:
```

### CriticExecutor

Manages execution with critic feedback loops.

```{eval-rst}
.. autoclass:: braid.critic.CriticExecutor
   :members:
   :undoc-members:
   :show-inheritance:
```

### PPDAnalyzer

Performance-per-Dollar analysis.

```{eval-rst}
.. autoclass:: braid.metrics.PPDAnalyzer
   :members:
   :undoc-members:
   :show-inheritance:
```

### SyntheticDataGenerator

Generates BRAID-compliant training data.

```{eval-rst}
.. autoclass:: braid.training.SyntheticDataGenerator
   :members:
   :undoc-members:
   :show-inheritance:
```

### ArchitectTrainer

Fine-tuning utilities for Architect models.

```{eval-rst}
.. autoclass:: braid.training.ArchitectTrainer
   :members:
   :undoc-members:
   :show-inheritance:
```