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

doc: Update doc on switchback experiment #78

Merged
merged 6 commits into from
Jul 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
4 changes: 2 additions & 2 deletions .github/workflows/xp.yml
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ jobs:
id: setup-python
uses: actions/setup-python@v2
with:
python-version: "3.7"
python-version: "3.10"
architecture: x64
- name: Install dependencies
run: make install-python-ci-dependencies
Expand Down Expand Up @@ -185,7 +185,7 @@ jobs:
id: setup-python
uses: actions/setup-python@v2
with:
python-version: "3.7"
python-version: "3.10"
architecture: x64

- name: Install dependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ XP support various experiment types.

- **A/B Experiments** - Treatment assignment is randomized on the unit supplied in the request and one of the treatments in the experiment will be chosen at random, accounting for the traffic allocation for each treatment.
- **Switchback Experiments** - The main idea behind switchback experiments is that the experiment engine switches back and forth between the control and treatment configurations, per configured time interval. In XP, switchback experiments can have one or more treatments and the engine cycles through them, selecting one treatment for all requests in every time interval.
- **Randomized Switchback Experiments** - This is a hybrid between the A/B experiments and Switchbacks. These experiments are Switchbacks by nature (they have a time interval). In addition, they can have a traffic allocation on each of the treatments. Thus, at every new interval, the selection of the treatment is not cyclical, but randomized. In the default mode, all requests in a given time interval will still receive the same treatment. However, it is also possible to vary this.
- **Randomized Switchback Experiments** - This is a hybrid between the A/B experiments and Switchbacks. These experiments are Switchbacks by nature (they have a time interval). In addition, they can have a traffic allocation on each of the treatments. Thus, at every new interval, the selection of the treatment is not cyclical, but randomized. All requests in a given time interval will receive the same treatment.
deadlycoconuts marked this conversation as resolved.
Show resolved Hide resolved

#### Experiment Hierarchy

Expand Down
7 changes: 5 additions & 2 deletions tests/e2e/test_validate_treatment.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
from xp_client import XPClient


def test_validate_valid_treatment_with_url(xp_client: XPClient):
def test_validate_valid_treatment_with_url(xp_client: XPClient, httpserver):
# Start test server for external validation endpoint
httpserver.expect_request("/external", method="POST").respond_with_json({})

data = {
"validation_url": "http://www.mocky.io/v2/5e4cacd4310000e1cad8c073",
"validation_url": httpserver.url_for("/external"),
deadlycoconuts marked this conversation as resolved.
Show resolved Hide resolved
"data": {"field1": "abc", "field2": "def", "field3": {"field4": 0.1}},
}

Expand Down
3 changes: 2 additions & 1 deletion tests/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
PyYAML==5.4.1
PyYAML==6.0.1
google-cloud-pubsub==2.7.0
requests==2.26.0
pytest-httpserver==1.0.10
python-dotenv==0.19.0
s2cell==1.4.0
pytz==2021.1
Expand Down
2 changes: 1 addition & 1 deletion treatment-service/go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ require (
github.com/caraml-dev/mlp v1.7.7-0.20230428104022-779530aec912
github.com/caraml-dev/xp/clients v0.0.0-00010101000000-000000000000
github.com/caraml-dev/xp/common v0.0.0
github.com/confluentinc/confluent-kafka-go v1.8.2
github.com/confluentinc/confluent-kafka-go v1.9.2
deadlycoconuts marked this conversation as resolved.
Show resolved Hide resolved
github.com/deepmap/oapi-codegen v1.11.0
github.com/getkin/kin-openapi v0.94.0
github.com/go-chi/chi/v5 v5.0.7
Expand Down
Loading
Loading