Document requesting no noise with a sentinel value #186
Conversation
| @@ -19,6 +19,9 @@ Due to this fine-grained control, there are a very large number of settings. | |||
| **It is not necessary to configure everything.** | |||
| pseudopeople includes reasonable default noise settings | |||
| and your configuration can override as few or as many of the default values as you like. | |||
| You can also pass the special value :code:`pseudopeople.NO_NOISE`, which prevents all configurable noise types | |||
| from occurring at all. | |||
|
|
|||
There was a problem hiding this comment.
I'm curious what alternatives were considered for the interface, e.g., an option boolean skip_noising or something like that.
There was a problem hiding this comment.
I don't think we directly considered that; it's not a bad idea but it does add an extra "degree of freedom" i.e. someone could set the boolean to False but pass a configuration that specifies no noise, or vice versa.
The other reason I like this API is that in the future, pseudopeople.NO_NOISE could change from being a sentinel value to actually being the full configuration for no noise, and it would be backwards-compatible.
|
I'm merging this; we plan to implement soon. As discussed, there may be another docs PR necessary once we have this implemented (e.g. for the API reference). |
Document requesting no noise with a sentinel value
Description
Adds some documentation of a special value that can be passed to dataset generation functions, to generate datasets with no (configurable) noise. (Configurable noise is all noise except "borrowed SSN.")
Testing
Built locally.