Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kenben authored Sep 2, 2016
1 parent 7667f17 commit 42290a1
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions Features/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,4 +44,9 @@ We have several possible definition schemes for choosing outcomes. We create a c
### Feature Descriptions
A full list of all features can be found in all_features.yaml, and any new feature must be manually added to that list before it can be used.
An asterisk after a feature name indicates that it has a feature for each grade level (formatted as `_gr_x` for some grade level x).

The scripts to generate each set of features is called in `generate_features.py`.

When writing a new feature, you should write a new `generate_myFeature.py`, which needs to write a table to the `model` schema. That table needs to be indexed by `student_lookup`. If your feature is dependent on time (which is encoded by grade level), then the grades should be dummified; the columns need to end on `_gr_x`. If a student repeats a grade, then the feature should use data from the first time they were in a given grade.

Look at `generate_example.py` for a feature generation template.

0 comments on commit 42290a1

Please sign in to comment.