BRAID-DSPy
Contents
Installation
API Reference
Examples
Basic Usage
GSM8K Benchmark Example
Optimization Example
BRAID-DSPy Integration Guide
BRAID-DSPy
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
_
__call__() (braid.module.BraidReasoning method)
,
[1]
__init__() (braid.critic.CriticExecutor method)
(braid.engine.StatefulExecutionEngine method)
(braid.generator.GRDGenerator method)
,
[1]
(braid.masking.NumericalMasker method)
(braid.metrics.PPDAnalyzer method)
(braid.module.BraidReasoning method)
,
[1]
(braid.module.BraidResult method)
,
[1]
(braid.optimizer.BraidOptimizer method)
,
[1]
(braid.parser.GRDEdge method)
(braid.parser.GRDNode method)
(braid.parser.GRDStructure method)
,
[1]
(braid.parser.MermaidParser method)
,
[1]
(braid.training.ArchitectTrainer method)
(braid.training.SyntheticDataGenerator method)
(braid.validators.AtomicityValidator method)
(braid.validators.GRDValidator method)
(braid.validators.ProceduralScaffoldingValidator method)
A
add_example() (braid.generator.GRDGenerator method)
,
[1]
answer (braid.module.BraidResult attribute)
,
[1]
(braid.signatures.BraidReasoningSignature attribute)
ArchitectTrainer (class in braid.training)
atomicity_score() (braid.optimizer.GRDMetrics static method)
,
[1]
AtomicityValidator (class in braid.validators)
B
braid.generator
module
braid.module
module
braid.optimizer
module
braid.parser
module
braid.signatures
module
BraidExecuteSignature (class in braid.signatures)
,
[1]
BraidOptimizer (class in braid.optimizer)
,
[1]
BraidPlanSignature (class in braid.signatures)
,
[1]
BraidReasoning (class in braid.module)
,
[1]
BraidReasoningSignature (class in braid.signatures)
BraidResult (class in braid.module)
,
[1]
BraidStepSignature (class in braid.signatures)
C
calculate_cost() (braid.metrics.PPDAnalyzer method)
calculate_dataset_stats() (braid.training.ArchitectTrainer method)
calculate_ppd_score() (braid.metrics.PPDAnalyzer method)
can_reach() (braid.engine.StatefulExecutionEngine method)
CIRCLE (braid.parser.NodeType attribute)
compare_with_baseline() (braid.metrics.PPDAnalyzer method)
completeness() (braid.optimizer.GRDMetrics static method)
,
[1]
condition (braid.parser.GRDEdge attribute)
context (braid.signatures.BraidStepSignature attribute)
count_tokens() (braid.validators.AtomicityValidator method)
create_dspy_examples() (braid.training.ArchitectTrainer method)
CRITIC_PATTERNS (braid.critic.CriticDetector attribute)
CriticDetector (class in braid.critic)
CriticExecutor (class in braid.critic)
current_step (braid.signatures.BraidExecuteSignature attribute)
,
[1]
CYLINDRICAL (braid.parser.NodeType attribute)
D
DEFAULT_EXAMPLES (braid.generator.GRDGenerator attribute)
,
[1]
DEFAULT_MAX_ITERATIONS (braid.engine.StatefulExecutionEngine attribute)
DEFAULT_MAX_RETRIES (braid.critic.CriticExecutor attribute)
DEFAULT_MAX_TOKENS (braid.validators.AtomicityValidator attribute)
DEFAULT_MAX_TOTAL_STEPS (braid.engine.StatefulExecutionEngine attribute)
detailed_quality_report() (braid.optimizer.GRDMetrics static method)
,
[1]
detect_critics() (braid.critic.CriticDetector method)
detect_cycles() (braid.engine.StatefulExecutionEngine method)
detect_leakage() (braid.masking.NumericalMasker method)
DIAMOND (braid.parser.NodeType attribute)
E
EDGE_PATTERN (braid.parser.MermaidParser attribute)
,
[1]
edges (braid.parser.GRDStructure attribute)
,
[1]
end_nodes (braid.parser.GRDStructure attribute)
,
[1]
error (braid.module.BraidResult attribute)
,
[1]
estimate_baseline_cost() (braid.metrics.PPDAnalyzer method)
evaluate() (braid.optimizer.BraidOptimizer method)
,
[1]
EXCLUDE_PATTERNS (braid.masking.NumericalMasker attribute)
execute() (braid.engine.StatefulExecutionEngine method)
execute_with_feedback() (braid.critic.CriticExecutor method)
execution_trace (braid.module.BraidResult attribute)
,
[1]
execution_traceability() (braid.optimizer.GRDMetrics static method)
,
[1]
extract_execution_steps() (braid.parser.MermaidParser method)
,
[1]
F
FAILURE_EDGE_PATTERNS (braid.critic.CriticDetector attribute)
forward() (braid.module.BraidReasoning method)
,
[1]
from_node (braid.parser.GRDEdge attribute)
G
generate() (braid.generator.GRDGenerator method)
,
[1]
generate_logic_samples() (braid.training.SyntheticDataGenerator method)
generate_math_samples() (braid.training.SyntheticDataGenerator method)
generate_mixed_samples() (braid.training.SyntheticDataGenerator method)
generate_reasoning_samples() (braid.training.SyntheticDataGenerator method)
generate_report() (braid.metrics.PPDAnalyzer method)
generate_training_dataset() (braid.training.ArchitectTrainer method)
get_cost_analysis() (braid.metrics.PPDAnalyzer method)
get_critic() (braid.critic.CriticExecutor method)
get_critic_type() (braid.critic.CriticDetector method)
get_execution_order() (braid.parser.GRDStructure method)
,
[1]
get_feedback_loops() (braid.critic.CriticDetector method)
get_incoming_edges() (braid.parser.GRDStructure method)
,
[1]
get_model_config() (braid.metrics.PPDAnalyzer method)
get_node_by_id() (braid.parser.GRDStructure method)
,
[1]
get_outgoing_edges() (braid.parser.GRDStructure method)
,
[1]
get_template() (braid.generator.GRDGenerator method)
,
[1]
grd (braid.module.BraidResult attribute)
,
[1]
(braid.signatures.BraidExecuteSignature attribute)
,
[1]
(braid.signatures.BraidPlanSignature attribute)
,
[1]
(braid.signatures.BraidReasoningSignature attribute)
GRDEdge (class in braid.parser)
GRDGenerator (class in braid.generator)
,
[1]
GRDMetrics (class in braid.optimizer)
,
[1]
GRDNode (class in braid.parser)
GRDStructure (class in braid.parser)
,
[1]
GRDValidator (class in braid.validators)
H
has_cycles() (braid.engine.StatefulExecutionEngine method)
HEXAGON (braid.parser.NodeType attribute)
I
id (braid.parser.GRDNode attribute)
is_critic_node() (braid.critic.CriticDetector method)
(braid.critic.CriticExecutor method)
L
label (braid.parser.GRDEdge attribute)
(braid.parser.GRDNode attribute)
LEAKAGE_PATTERNS (braid.validators.ProceduralScaffoldingValidator attribute)
LOGIC_TEMPLATES (braid.training.SyntheticDataGenerator attribute)
M
mask() (braid.masking.NumericalMasker method)
mask_grd_nodes() (braid.masking.NumericalMasker method)
masking_compliance() (braid.optimizer.GRDMetrics static method)
,
[1]
MATH_TEMPLATES (braid.training.SyntheticDataGenerator attribute)
MermaidParser (class in braid.parser)
,
[1]
metadata (braid.parser.GRDNode attribute)
(braid.parser.GRDStructure attribute)
,
[1]
model_config (braid.signatures.BraidExecuteSignature attribute)
,
[1]
(braid.signatures.BraidPlanSignature attribute)
,
[1]
(braid.signatures.BraidReasoningSignature attribute)
(braid.signatures.BraidStepSignature attribute)
MODEL_CONFIGS (braid.metrics.PPDAnalyzer attribute)
module
braid.generator
braid.module
braid.optimizer
braid.parser
braid.signatures
N
NODE_PATTERNS (braid.parser.MermaidParser attribute)
,
[1]
node_type (braid.parser.GRDNode attribute)
nodes (braid.parser.GRDStructure attribute)
,
[1]
NodeType (class in braid.parser)
NUMERICAL_PATTERNS (braid.masking.NumericalMasker attribute)
NumericalMasker (class in braid.masking)
O
optimize() (braid.optimizer.BraidOptimizer method)
,
[1]
overall_quality() (braid.optimizer.GRDMetrics static method)
,
[1]
P
PARALLELOGRAM (braid.parser.NodeType attribute)
parse() (braid.parser.MermaidParser method)
,
[1]
parsed_grd (braid.module.BraidResult attribute)
,
[1]
PLACEHOLDER_PREFIX (braid.masking.NumericalMasker attribute)
PLACEHOLDER_SUFFIX (braid.masking.NumericalMasker attribute)
PPDAnalyzer (class in braid.metrics)
prepare_openai_finetune_dataset() (braid.training.ArchitectTrainer method)
previous_results (braid.signatures.BraidExecuteSignature attribute)
,
[1]
problem (braid.module.BraidResult attribute)
,
[1]
(braid.signatures.BraidExecuteSignature attribute)
,
[1]
(braid.signatures.BraidPlanSignature attribute)
,
[1]
(braid.signatures.BraidReasoningSignature attribute)
procedural_scaffolding_score() (braid.optimizer.GRDMetrics static method)
,
[1]
ProceduralScaffoldingValidator (class in braid.validators)
process_critic_output() (braid.critic.CriticExecutor method)
R
reasoning_steps (braid.module.BraidResult attribute)
,
[1]
(braid.signatures.BraidReasoningSignature attribute)
REASONING_TEMPLATES (braid.training.SyntheticDataGenerator attribute)
RECTANGLE (braid.parser.NodeType attribute)
reset() (braid.engine.StatefulExecutionEngine method)
(braid.metrics.PPDAnalyzer method)
ROUNDED (braid.parser.NodeType attribute)
S
SCAFFOLDING_PATTERNS (braid.validators.ProceduralScaffoldingValidator attribute)
STADIUM (braid.parser.NodeType attribute)
start_nodes (braid.parser.GRDStructure attribute)
,
[1]
StatefulExecutionEngine (class in braid.engine)
step_description (braid.signatures.BraidStepSignature attribute)
step_output (braid.signatures.BraidStepSignature attribute)
step_result (braid.signatures.BraidExecuteSignature attribute)
,
[1]
structural_validity() (braid.optimizer.GRDMetrics static method)
,
[1]
style (braid.parser.GRDEdge attribute)
SUBROUTINE (braid.parser.NodeType attribute)
SyntheticDataGenerator (class in braid.training)
T
to_node (braid.parser.GRDEdge attribute)
track_usage() (braid.metrics.PPDAnalyzer method)
TRAPEZOID (braid.parser.NodeType attribute)
U
UNKNOWN (braid.parser.NodeType attribute)
unmask() (braid.masking.NumericalMasker method)
V
valid (braid.module.BraidResult attribute)
,
[1]
validate() (braid.parser.MermaidParser method)
,
[1]
(braid.validators.GRDValidator method)
validate_and_report() (braid.validators.GRDValidator method)
validate_grd() (braid.validators.AtomicityValidator method)
(braid.validators.ProceduralScaffoldingValidator method)
validate_node() (braid.validators.AtomicityValidator method)
(braid.validators.ProceduralScaffoldingValidator method)
validate_samples() (braid.training.SyntheticDataGenerator method)