Skip to content

Dao

Abstract class interfacing any kind of underlying data source.

Source code in src/epstats/toolkit/dao.py 
 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
class Dao:
    """
    Abstract class interfacing any kind of underlying data source.
    """

    def get_unit_goals(self, experiment: Experiment) -> pd.DataFrame:
        """
        Get goals data pre-aggregated by `exp_variant_id`, `unit_type`, `agg_type`, `goal`,
        `unit_id` and any dimension columns (in case of dimensional metrics).

        See [`Experiment.evaluate_by_unit`][epstats.toolkit.experiment.Experiment.evaluate_by_unit] for column
        descriptions and example result.
        """
        pass

    def get_agg_goals(self, experiment: Experiment) -> pd.DataFrame:
        """
        Get goals data pre-aggregated by `exp_variant_id`, `unit_type`, `agg_type`, `goal`,
        `unit_id` and any dimension columns (in case of dimensional metrics)

        See [`Experiment.evaluate_agg`][epstats.toolkit.experiment.Experiment.evaluate_agg] for column
        descriptions and example result.
        """
        pass

    def close(self) -> None:
        """
        Close underlying data source connection and frees resources (if any).
        """
        pass

close()

Close underlying data source connection and frees resources (if any).

Source code in src/epstats/toolkit/dao.py 
31
32
33
34
35
def close(self) -> None:
    """
    Close underlying data source connection and frees resources (if any).
    """
    pass

get_agg_goals(experiment)

Get goals data pre-aggregated by exp_variant_id, unit_type, agg_type, goal, unit_id and any dimension columns (in case of dimensional metrics)

See Experiment.evaluate_agg for column descriptions and example result.

Source code in src/epstats/toolkit/dao.py 
21
22
23
24
25
26
27
28
29
def get_agg_goals(self, experiment: Experiment) -> pd.DataFrame:
    """
    Get goals data pre-aggregated by `exp_variant_id`, `unit_type`, `agg_type`, `goal`,
    `unit_id` and any dimension columns (in case of dimensional metrics)

    See [`Experiment.evaluate_agg`][epstats.toolkit.experiment.Experiment.evaluate_agg] for column
    descriptions and example result.
    """
    pass

get_unit_goals(experiment)

Get goals data pre-aggregated by exp_variant_id, unit_type, agg_type, goal, unit_id and any dimension columns (in case of dimensional metrics).

See Experiment.evaluate_by_unit for column descriptions and example result.

Source code in src/epstats/toolkit/dao.py 
11
12
13
14
15
16
17
18
19
def get_unit_goals(self, experiment: Experiment) -> pd.DataFrame:
    """
    Get goals data pre-aggregated by `exp_variant_id`, `unit_type`, `agg_type`, `goal`,
    `unit_id` and any dimension columns (in case of dimensional metrics).

    See [`Experiment.evaluate_by_unit`][epstats.toolkit.experiment.Experiment.evaluate_by_unit] for column
    descriptions and example result.
    """
    pass