Currently, featurize.py (https://github.com/Watts-Lab/team-process-map/blob/main/feature_engine/featurize.py) serves as a "catch-all script" that both functions to test the code and functions as an example constructor. We should separate these two functionalities, and create a separate examples/ folder or repository that achieves the following:
Highlights the featurizer's functionality. The example repository should contain some scripts or iPython notebooks that illustrate how a user can install the package and get started. There should be a sample dataset that they can play with (similar to how R has example datasets such as cars and iris), and the scripts should illustrate how one can instantiate a Featurizer and generate features for a conversation.
Currently,
featurize.py(https://github.com/Watts-Lab/team-process-map/blob/main/feature_engine/featurize.py) serves as a "catch-all script" that both functions to test the code and functions as an example constructor. We should separate these two functionalities, and create a separateexamples/folder or repository that achieves the following:carsandiris), and the scripts should illustrate how one can instantiate a Featurizer and generate features for a conversation.