Skip to content

Commit

Permalink
Merge pull request #31 from team-boomeraang/kh-v1-dev
Browse files Browse the repository at this point in the history
Add final milestone task tracker
  • Loading branch information
minhuanli authored Nov 29, 2020
2 parents acb2528 + 5bc35c6 commit 001a702
Showing 1 changed file with 56 additions and 0 deletions.
56 changes: 56 additions & 0 deletions docs/final_milestone_tasks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
## Team Boomdiff - Final Milestone

Broadly, there are four areas still left to implement for the final milestone, each of which will require updated testing;

- Optimization library implementation
- Updated documentation/packaging
- Additional forward-mode requirements - functions with multiple vector/scalar inputs
- Deliverables
- Broader impact statement
- Video

The breakdown for grading for these sections is as follows:

| Points | Task |
| ------ | ------------------------------------ |
| 20 | Complete forward mode implementation |
| 15 | Documentation & Test Suite |
| 4 | Broader Impact Statement |
| 20 | Video presentation |
| 30 | New feature (optimization library) |
| 15 | Code quality |

In terms of tasks remaining, we have the following:

##### Forward mode implementation

| Task | Team member | Status |
| ------------------------------------------------------------ | ----------- | ------ |
| Update existing functions for multiple inputs, where applicable | | |
| `__eq__`, `__neq__`, other comparison operators | | |
| inverse trig functions (arcsine, arctan, arccos) | | |
| hyperbolic functions (sinh, tanh, cosh) | | |
| logistic function | | |
| logarithm - expand to any base with default of e | | |
| square root | | |

##### Documentation, software organization, deliverables

| Task | Team member | Status |
| ------------------------------------------------------------ | ----------- | ----------- |
| Discuss reorganization suggested by David | All | |
| (TBD) Reorganize software package for optimization | | |
| Add extension documentation to reflect implementation details | | |
| Revise background & how-to-use sections | | |
| Broader impact statement | | |
| Plan video & record | All | |
| Make package pip-installable | Kevin | In progress |

##### Optimization library

| Task | Team member | Status |
| ------------------------------------------------------------ | ----------- | ------ |
| Base objective function class | | |
| Implement gradient descent optimization | | |
| Implement random coordinate descent (or other opt. algorithm) | | |

0 comments on commit 001a702

Please sign in to comment.