Skip to content

Commit f605f51

Browse files
committed
fix review
1 parent c7b971d commit f605f51

File tree

1 file changed

+12
-14
lines changed

1 file changed

+12
-14
lines changed

prebid-server/pbs-modules/greenbids-real-time-data.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,14 @@ sidebarType : 5
1010

1111
## Overview
1212

13-
Greenbids Real Time Data module filters bidders
14-
SSPs listed in the `imp[].ext.prebid.bidder`
15-
of the bid request. To perform the filtering the module uses the ML pipeline that outputs the probability
16-
of bid per SSP for each `imp` for the given bid request.
17-
Then this probability of bid is compared with the threshold to ensure the necessary level of filtering for a partner publisher.
13+
Greenbids Real Time Data module filters bidders SSPs listed in the `imp[].ext.prebid.bidder` of the bid request.
14+
To perform the filtering the module uses AI to predict the bidding probability of bid per SSP for each `imp` for the given bid request.
15+
This bidding probability is used to choose to send the bid request or not, according to the performance constraints applied by the partner publisher.
1816

1917
The RTD module uses 2 artefacts that are fetched from the Greenbids Google Cloud Storage bucket
2018

21-
- ML predictor in `.onnx` format
22-
- Probability thresholds in `.json` format with the list of thresholds and their corresponding target metrics
19+
- ML predictor in `.onnx` format: used to predict the bidding probability
20+
- Probability thresholds in `.json` format: used to convert the bidding probability to a binary choice
2321

2422
## Configuration
2523

@@ -67,7 +65,7 @@ hooks:
6765
- `google-cloud-greenbids-project`: Google Cloud project associated with Greenbids
6866
- `gcs-bucket-name`: Google Cloud Storage (GCS) bucket used to fetch the artefacts ([ONNX](https://onnx.ai/) model and thresholds `.json`) necessary for prediction
6967
- `cache-expiration-minutes`: The duration (in minutes) after which cached model and thresholds should be considered expired and refreshed
70-
- `geo-lite-country-path`: Geolocation capabilities to determine the country from an IP address
68+
- `geo-lite-country-path`: URL to the geo-ip database
7169
- `onnx-model-cache-key-prefix`: prefix necessary for getting cached ONNX model
7270
- `thresholds-cache-key-prefix`: prefix necessary for getting cached throttling thresholds
7371

@@ -94,10 +92,10 @@ The list of the parameters necessary for RTD module activation is as follows:
9492
| Parameter | Scope | Description | Example | Type |
9593
|-----------------|-------------------|-----------------------------------------------------------------------------------------------------|-----------------------|--------------|
9694
| pbuid | required | The Greenbids Publisher ID | greenbids-publisher-1 | string |
97-
| targetTpr | required | Ratio of passing the valid bids [0-1] | 0.9 | float |
95+
| targetTpr | required | Expected retained opportunities ratio [0-1] | 0.9 | float |
9896
| explorationRate | required | Ratio of traffic without filtering used for training ML model [0-1] (a value of 0.1 will filter 90% of the traffic) | 0.1 | float |
9997

100-
Here's an example of how a PBS partner publisher setup using both Greenbids RTD Module and Greenbids AnalyticsReporter shoudl look like:
98+
Here's an example of how a PBS partner publisher setup using both Greenbids RTD Module and Greenbids AnalyticsReporter should look like:
10199

102100
```json
103101
"ext": {
@@ -106,7 +104,7 @@ Here's an example of how a PBS partner publisher setup using both Greenbids RTD
106104
// extension for Greenbids Analytics Reporter
107105
"greenbids": {
108106
"pbuid": "PBUID_FROM_GREENBIDS",
109-
"greenbidsSampling": 1
107+
"greenbidsSampling": 0.01
110108
},
111109
// extension for Greenbids Real Time Data Module
112110
"greenbids-rtd": {
@@ -134,11 +132,11 @@ hooks:
134132
## Analytics Tags
135133

136134
The RTD module also communicates the filtering results with the `GreenbidsAnalyticsReporter` via [AnalyticsTags](https://docs.prebid.org/prebid-server/developers/module-atags.html).
137-
Here we populate analytics result of analytics tags for each `imp` the with
135+
Here we populate analytics result of analytics tags for each `imp` the with:
138136

139137
- `fingerprint`: greenbidsId
140-
- `isKeptInAuction` map of booleans for each bidder whether we keep them in auction or not for the given imp
141-
- `isExploration`flag that is necessary to isolate the training data
138+
- `isKeptInAuction`: map of booleans for each bidder whether we keep them in auction or not for the given imp
139+
- `isExploration`: flag that is necessary to isolate the training data
142140

143141
The analytics tag is then parsed by the AnalyticsReporter from `HookExecutionContext`
144142
and its content added to the analytics payload sent to Greenbids server. The exploration part of traffic is split randomly with the ratio defined for each partner publisher

0 commit comments

Comments
 (0)