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 description for cache_mode option of DFP Rolling Window module #1707

Merged
merged 2 commits into from
May 29, 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
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ This module function sets up modular Digital Fingerprinting Pipeline instance.

| Parameter | Type | Description | Example Value | Default Value |
|-------------------------|--------|-------------------------------------------------------------|---------------|---------------|
| `cache_mode` | string | The user ID to use if the user ID is not found | "batch" | `batch` |
| `cache_mode` | string | Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are met. Otherwise, continue to aggregate user's history. | "batch" | `batch` |
| `min_history` | int | Minimum history to trigger a new training event | 1 | `1` |
| `max_history` | int | Maximum history to include in a new training event | 0 | `0` |
| `timestamp_column_name` | string | Name of the column containing timestamps | "timestamp" | `timestamp` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ into a single module.

| Parameter | Type | Description | Example Value | Default Value |
|-------------------------|--------|-------------------------------------------------------------|---------------|---------------|
| `cache_mode` | string | The user ID to use if the user ID is not found | "batch" | `batch` |
| `cache_mode` | string | Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are met. Otherwise, continue to aggregate user's history. | "batch" | `batch` |
| `min_history` | int | Minimum history to trigger a new training event | 1 | `1` |
| `max_history` | int | Maximum history to include in a new training event | 0 | `0` |
| `timestamp_column_name` | string | Name of the column containing timestamps | "timestamp" | `timestamp` |
Expand Down Expand Up @@ -105,7 +105,7 @@ into a single module.
},
"stream_aggregation_options": {
"timestamp_column_name": "timestamp",
"cache_mode": "MEMORY",
"cache_mode": "batch",
"trigger_on_min_history": true,
"aggregation_span": "1D",
"trigger_on_min_increment": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This module is responsible for maintaining a rolling window of historical data,

| Parameter | Type | Description | Example Value | Default Value |
|--------------------------|--------|--------------------------------------------------------------|---------------|---------------|
| cache_mode | string | The user ID to use if the user ID is not found | "batch" | "batch" |
| cache_mode | string | Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are met. Otherwise, continue to aggregate user's history. | "batch" | "batch" |
| trigger_on_min_history | int | Minimum history to trigger a new training event | 1 | 1 |
| trigger_on_min_increment | int | Minmum increment from the last trained to new training event | 0 | 0 |
| timestamp_column_name | string | Name of the column containing timestamps | "timestamp" | "timestamp" |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ This module function consolidates multiple DFP pipeline modules relevant to the

| Key | Type | Description | Example Value | Default Value |
|-------------------------|--------|-------------------------------------------------------------|---------------|---------------|
| `cache_mode` | string | The user ID to use if the user ID is not found | "batch" | `batch` |
| `cache_mode` | string | Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are met. Otherwise, continue to aggregate user's history. | "batch" | `batch` |
| `min_history` | int | Minimum history to trigger a new training event | 1 | `1` |
| `max_history` | int | Maximum history to include in a new training event | 0 | `0` |
| `timestamp_column_name` | string | Name of the column containing timestamps | 'timestamp' | `timestamp` |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,8 @@ def dfp_deployment(builder: mrc.Builder):
- timestamp_column_name (str): Name of the timestamp column; Example: `timestamp`; Default: timestamp

stream_aggregation_options:
- cache_mode (str): The user ID to use if the user ID is not found; Example: 'batch'; Default: 'batch'
- cache_mode (str): Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are
met. Otherwise, continue to aggregate user's history.; Example: 'batch'; Default: 'batch'
- trigger_on_min_history (int): Minimum history to trigger a new training event; Example: 1; Default: 1
- trigger_on_min_increment (int): Minmum increment from the last trained to new training event;
Example: 0; Default: 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,8 @@ def dfp_inference_pipe(builder: mrc.Builder):
- timestamp_column_name (str): Name of the timestamp column; Example: "timestamp"; Default: timestamp

stream_aggregation_options:
- cache_mode (str): The user ID to use if the user ID is not found; Example: 'batch'; Default: 'batch'
- cache_mode (str): Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions
are met. Otherwise, continue to aggregate user's history.; Example: 'batch'; Default: 'batch'
- trigger_on_min_history (int): Minimum history to trigger a new training event; Example: 1; Default: 1
- trigger_on_min_increment (int): Minimum increment from the last trained to new training event;
Example: 0; Default: 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,8 @@ def dfp_rolling_window(builder: mrc.Builder):
Notes
-----
Configurable parameters:
- cache_mode (str): The user ID to use if the user ID is not found; Example: 'batch'; Default: 'batch'
- cache_mode (str): Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are
met. Otherwise, continue to aggregate user's history.; Example: 'batch'; Default: 'batch'
- trigger_on_min_history (int): Minimum history to trigger a new training event; Example: 1; Default: 1
- trigger_on_min_increment (int): Minmum increment from the last trained to new training event;
Example: 0; Default: 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,8 @@ def dfp_training_pipe(builder: mrc.Builder):
- timestamp_column_name (str): Name of the timestamp column; Example: `timestamp`; Default: timestamp

stream_aggregation_options:
- cache_mode (str): The user ID to use if the user ID is not found; Example: 'batch'; Default: 'batch'
- cache_mode (str): Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions
are met. Otherwise, continue to aggregate user's history.; Example: 'batch'; Default: 'batch'
- trigger_on_min_history (int): Minimum history to trigger a new training event; Example: 1; Default: 1
- trigger_on_min_increment (int): Minimum increment from the last trained to new training event;
Example: 0; Default: 0
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ def infer_module_conf(self):
"stream_aggregation_options": {
"aggregation_span": "1d",
"cache_to_disk": False,
"cache_mode": "streaming",
"cache_mode": "batch",
},
"preprocessing_options": {
"schema": {
Expand Down Expand Up @@ -139,7 +139,7 @@ def train_module_conf(self):
"stream_aggregation_options": {
"aggregation_span": "60d",
"cache_to_disk": False,
"cache_mode": "streaming",
"cache_mode": "aggregate",
"trigger_on_min_history": 300,
"trigger_on_min_increment": 300
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@
"\n",
"| Parameter | Type | Description | Example Value | Default Value |\n",
"|-------------------------|--------|-------------------------------------------------------------|---------------|---------------|\n",
"| `cache_mode` | string | The user ID to use if the user ID is not found | \"batch\" | `batch` |\n",
"| `cache_mode` | string | Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are met. Otherwise, continue to aggregate user's history. | \"batch\" | `batch` |\n",
"| `min_history` | int | Minimum history to trigger a new training event | 1 | `1` |\n",
"| `max_history` | int | Maximum history to include in a new training event | 0 | `0` |\n",
"| `timestamp_column_name` | string | Name of the column containing timestamps | \"timestamp\" | `timestamp` |\n",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,7 @@
"\n",
"| Parameter | Type | Description | Example Value | Default Value |\n",
"|-------------------------|--------|-------------------------------------------------------------|---------------|---------------|\n",
"| `cache_mode` | string | The user ID to use if the user ID is not found | \"batch\" | `batch` |\n",
"| `cache_mode` | string | Mode for managing user cache. Setting to `batch` flushes cache once trigger conditions are met. Otherwise, continue to aggregate user's history. | \"batch\" | `batch` |\n",
"| `min_history` | int | Minimum history to trigger a new training event | 1 | `1` |\n",
"| `max_history` | int | Maximum history to include in a new training event | 0 | `0` |\n",
"| `timestamp_column_name` | string | Name of the column containing timestamps | \"timestamp\" | `timestamp` |\n",
Expand Down
Loading