search

facebookexperimental / Robyn

Robyn is an experimental, AI/ML-powered and open sourced Marketing Mix Modeling (MMM) package from Meta Marketing Science. Our mission is to democratise modeling knowledge, inspire the industry through innovation, reduce human bias in the modeling process & build a strong open source marketing science community.
https://facebookexperimental.github.io/Robyn/
MIT License
1.16k stars 346 forks source link

[feature] update robyn apis #1125

Closed alxlyj closed 2 weeks ago

alxlyj commented 2 weeks ago

Project Robyn

Summary

Create Robyn APIs - we are adding the API to:

We will add cluster and visualizer in a separate set of PR once other PRs have landed. 

sequenceDiagram
    participant User
    participant Robyn

    User ->> Robyn: Robyn(working_dir)
    User ->> Robyn: initialize(mmm_data, holidays_data, hyperparameters)
    User ->> Robyn: model_e2e_run(trials_config, ts_validation, ...)
    activate Robyn
    Robyn ->> Robyn: feature_engineering(plot)
    Robyn ->> Robyn: build_models(trials_config, ts_validation, ...)
    Robyn ->> Robyn: evaluate_models(pareto_fronts, min_candidates, ...)
    deactivate Robyn
    User ->> Robyn: budget_allocator(select_model, allocation_constraints, ...)

Test Plan

Please see tutorial1.ipynb:

image

The notebook runs successfully through initialize to allocator.