Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Adjustment docs #621

Merged
merged 1 commit into from
Sep 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/pipeline/triggers/COST_TRIGGER.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,11 @@ classDiagram
-bool evaluate_batch(batch, trigger_index)*
}

class WarmupTrigger {
-int warmup_intervals
+delegate_inform(batch)
}

class PerformanceTriggerMixin {
+DataDensityTracker data_density
+PerformanceTracker performance_tracker
Expand Down Expand Up @@ -78,6 +83,10 @@ classDiagram

Trigger <|-- BatchedTrigger
BatchedTrigger <|-- CostTrigger

BatchedTrigger o-- "0..1" WarmupTrigger
Trigger "1" --* WarmupTrigger

PerformanceTriggerMixin <|-- CostTrigger

CostTrigger *-- "1" CostTracker
Expand Down
12 changes: 9 additions & 3 deletions docs/pipeline/triggers/DRIFT_TRIGGER.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,12 @@ classDiagram
-bool evaluate_batch(batch, trigger_index)*
}

class WarmupTrigger {
-int warmup_intervals
+delegate_inform(batch)
}


class DataDriftTrigger {
+DataDriftTriggerConfig config
+DetectionWindows windows
Expand All @@ -49,6 +55,9 @@ classDiagram
Trigger <|-- BatchedTrigger
BatchedTrigger <|-- DataDriftTrigger

Trigger "1" --* WarmupTrigger
BatchedTrigger o-- "0..1" WarmupTrigger

DataDriftTrigger "warmup_trigger" *-- "1" Trigger
DataDriftTrigger *-- "1" DataDriftTriggerConfig
DataDriftTrigger *-- "1" DetectionWindows
Expand Down Expand Up @@ -264,9 +273,6 @@ classDiagram
DynamicDecisionPolicy <|-- DynamicRollingAverageThresholdPolicy
DriftDecisionPolicy <|-- HypothesisTestDecisionPolicy

DynamicDecisionPolicy <|-- DynamicPercentileThresholdPolicy
DynamicDecisionPolicy <|-- DynamicRollingAverageThresholdPolicy

style HypothesisTestDecisionPolicy fill:#DDDDDD,stroke:#A9A9A9,stroke-width:2px
```

Expand Down
9 changes: 9 additions & 0 deletions docs/pipeline/triggers/PERFORMANCE_TRIGGER.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,11 @@ classDiagram
-bool evaluate_batch(batch, trigger_index)*
}

class WarmupTrigger {
-int warmup_intervals
+delegate_inform(batch)
}

class PerformanceTriggerMixin {
+DataDensityTracker data_density
+PerformanceTracker performance_tracker
Expand Down Expand Up @@ -67,6 +72,10 @@ classDiagram

Trigger <|-- BatchedTrigger
BatchedTrigger <|-- PerformanceTrigger

BatchedTrigger o-- "0..1" WarmupTrigger
Trigger "1" --* WarmupTrigger

PerformanceTriggerMixin <|-- PerformanceTrigger
PerformanceTrigger *-- "1" PerformanceTriggerConfig
PerformanceTrigger *-- "1" DataDensityTracker
Expand Down
Loading