Skip to content

Commit

Permalink
Create a template and directory for algorithm
Browse files Browse the repository at this point in the history
  • Loading branch information
dhimmel committed Aug 8, 2016
1 parent 5eadf03 commit eea895c
Show file tree
Hide file tree
Showing 3 changed files with 1,355 additions and 0 deletions.
17 changes: 17 additions & 0 deletions algorithms/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Notebooks implementing various sklearn classifiers

This directory hosts notebooks created in response to [Issue #27](https://github.com/cognoma/machine-learning/issues/27#issuecomment-238255454 "cognoma/machine-learning: Claim an sklearn algorithm to implement and troubleshoot") where team members can claim and implement an algorithm.

The recommended approach is to copy `SGDClassifier-template.ipynb` to a file named `algorithm-username.ipynb` and modify the newly created file. Implementations are encouraged to use grid search to find optimal algorithm hyperparameters. Finally, make sure you're using the `cognoma-machine-learning` conda environment described in the [README](https://github.com/cognoma/machine-learning/tree/5eadf0309a409b08fc17d81b36b9c4bcd7acb916#environment).

Once you've finished your notebook, you should run (from this directory):

```sh
# Restart and run all cells in your notebook
jupyter nbconvert --inplace --execute --ExecutePreprocessor.timeout=-1 algorithm-username.ipynb

# Export notebook to a .py script for diff viewing
jupyter nbconvert --to=script --FilesWriter.build_directory=scripts algorithm-username.ipynb
```

Then you can submit a pull request.
Loading

0 comments on commit eea895c

Please sign in to comment.