dssg / triage

General Purpose Risk Modeling and Prediction Toolkit for Policy and Social Good Problems
Other
185 stars 60 forks source link

Improve documentation of user_metadata #811

Closed ecsalomon closed 4 years ago

ecsalomon commented 4 years ago

The current documentation of user_metadata is not super clear about why this exists or what it could be used for, and the one example case is probably not clear to new folks.

These are arbitrary keys/values that you can have Triage apply to the metadata for every matrix in the experiment. Any keys you include here can be used in the model_group_keys below. For example, if you run the entity matching algorithm before running the experiment, one can include a matchdatetime in the user_metadata that signifies which set of entity_ids was used to create a given model/model group. That way, we don't accidentally match old predictions with new staged data without looking up the new entity_ids first.