hypertune 0.6.2

Hypertune SDK for type safe configuration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Map;
use serde_json::Number;
use serde_json::Value;

use crate::expression::Logs;

pub type SplitMap = HashMap<String, Split>;

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Split {
    pub id: String,
    pub r#type: SplitType,
    pub dimensions: HashMap<String, Dimension>,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
pub enum SplitType {
    #[serde(rename = "test")]
    Test,

    #[serde(rename = "ml")]
    ML,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(tag = "type", rename_all = "camelCase")]
pub enum Dimension {
    Discrete(DiscreteDimension),
    Continuous(ContinuousDimension),
}

impl Dimension {
    pub fn get_id(&self) -> &str {
        match self {
            Dimension::Discrete(d) => &d.id,
            Dimension::Continuous(d) => &d.id,
        }
    }
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct DiscreteDimension {
    pub id: String,
    split_id: String,
    index: u64,
    name: String,
    pub arms: HashMap<String, Arm>,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct ContinuousDimension {
    pub id: String,
    split_id: String,
    index: u64,
    name: String,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct Arm {
    pub id: String,
    dimension_id: String,
    pub index: u64,
    name: String,
    pub allocation: Number,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct CommitConfig {
    pub split_config: HashMap<String, SplitConfig>,
}

impl CommitConfig {
    pub fn new() -> Self {
        Self {
            split_config: HashMap::new(),
        }
    }
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(tag = "type")]
pub enum SplitConfig {
    EpsilonGreedyConfig(EpsilonGreedyConfig),
    PersonalizationSplitConfig(PersonalizationSplitConfig),
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct EpsilonGreedyConfig {
    pub epsilon: Number,
    pub best_assignment: HashMap<String, SplitAssignmentEntry>,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
pub struct PersonalizationSplitConfig {
    pub epsilon: Number,
    pub logic: HashMap<String, PersonalizationSplitLogicDimension>,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct PersonalizationSplitLogicDimension {
    pub rules: Vec<PersonalSplitLogicDimensionRule>,
    pub default_arm_id: String,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct PersonalSplitLogicDimensionRule {
    pub feature_values_path: Vec<String>,
    pub feature_value: Value,
    pub arm_id: String,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct AssignmentCacheValue {
    pub assignment: HashMap<String, SplitAssignmentEntry>,
    pub event_object_type_name: Option<String>,
    pub event_payload: Option<Map<String, Value>>,
    pub event_payload_logs: Option<Logs>,
}

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone, Hash)]
#[serde(rename_all = "camelCase")]
pub struct AssignmentCacheKey {
    pub split_id: String,
    pub unit_id: String,
}

pub type AssignmentCache = HashMap<AssignmentCacheKey, AssignmentCacheValue>;

#[derive(Deserialize, Serialize, Eq, PartialEq, Debug, Clone)]
#[serde(rename_all = "camelCase", tag = "type")]
pub enum SplitAssignmentEntry {
    #[serde(rename_all = "camelCase")]
    Discrete {
        arm_id: String,
    },

    Continuous {
        value: Number,
    },
}