Skip to content

Commit 9d2f207

Browse files
committed
Updated README with blacklist functionality
1 parent 3bfaa5c commit 9d2f207

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

python/README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,20 @@ set `MY_APP_NO_CONSENT=1`, then again no reports will get sent back.
126126
On the other hand, if the user has set `MY_APP_CONSENT=true` and left `MY_APP_NO_CONSENT` unset or
127127
set to a value other than `1`, Humbug will send you any reports you have configured.
128128

129+
### Blacklist
130+
131+
There is a possibility to provide custom functions or use predefined at `blacklist.filter_parameters_by_key` for blacklist functionality.
132+
133+
Just add a list of keys you want to remove from the `feature_report` result and specify the function:
134+
135+
```python
136+
reporter = Reporter(
137+
...
138+
blacklist_keys=["private"],
139+
blacklist_fn=blacklist.filter_parameters_by_key,
140+
)
141+
```
142+
129143
### Example: activeloopai/Hub
130144

131145
[This pull request](https://github.com/activeloopai/Hub/pull/624) shows how

0 commit comments

Comments
 (0)