Skip to content
This repository has been archived by the owner on Mar 29, 2023. It is now read-only.

Commit

Permalink
add hld for how inputs are handled by library
Browse files Browse the repository at this point in the history
  • Loading branch information
Michael Klear committed Aug 5, 2021
1 parent 1a284ad commit 59e74f9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,16 @@ Contributors are welcomed! Please reach out with PRs.
We'd like to release a stable version soon, so in the meantime please submit feature requests and bug reports on this repository's issues page.
## Thanks for your interest in this project!

# Dataframe Encoding
`dfencoder` does some manipulation to encode features to feed into the
feed-forward MLP. This HLD hopefully clears up how this looks.
![HLD for how inputs are encoded by dfencoder](demo_data/input_handling_hld.png)

# Features
This library is a personal project so progress is slow. The latest release as of this writing is `v0.0.36` which introduces handling for timestamp data; will use cyclical encoding to encode time of day, day of week, day of month, day of year, as well as the raw timestamp scaled as a numeric feature to encode raw linear time. <br><br>
This library is a personal project so progress is slow. The latest release as of this writing is `v0.0.37` which introduces "inference mode"
that optimizes inference for single records, on json inputs.

## Previous Releases:
`v0.0.36` which introduces handling for timestamp data; will use cyclical encoding to encode time of day, day of week, day of month, day of year, as well as the raw timestamp scaled as a numeric feature to encode raw linear time. <br><br>

Pre-process your timestamp columns by using pandas: `pd.to_datetime()` so `dfencoder` can infer the datatype and handle it accordingly.
Binary file added demo_data/input_handling_hld.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 59e74f9

Please sign in to comment.