Milestone 2



Due: Thursday, November 18th at 11:59 PM

Submission Instructions

You will be writing code for this milestone. Please be sure that we can find it in your project organization.

Your submission should be in the following format:

cs107-FinalProject/
├── docs
│   ├── milestone1
│   ├── milestone2
│   └── milestone2_progress
├── LICENSE
├── README.md
├── src
│   └── ...
└── ...

Note that src is a generic name used for source code containers. You may choose a different name for the directory that holds your project source code. It should be a concise name. Note too that the documentation for Milestone 2 will be a superset of that for Milestone 1. Hence, it should be in a new file.

Requirements

Here are the main requirements for the second milestone:

  1. Working forward mode implementation
  2. Note: For this milestone, you are not required to support multiple functions of multiple inputs yet. All tests run by the teaching staff will only be run on scalar functions of a single input.
  3. Test suite
  4. Updated / extended documentation
  5. Proposal for additional feature(s)

See the sections below for more specific details.

Working Forward Mode Implementation

You must have a working forward mode implementation. This does not mean, however, that you should have a complete implementation. Guidelines are in the following sections.

Minimum Package Requirements

Minimum Implementation Requirements

The following is a description of a typical use case.

There are other use cases as well. Someone may want to solve an optimization problem using the forward mode. Regardless, the workflow outlined above should be roughly the same.

What Kinds of Functions should be Implemented?

This document began by saying that you don't need to have the forward mode fully implemented. This section describes what that means.

Recall that eventually a user should be able to use your software to get derivatives of a vector function of a vector. You should keep this in mind when designing your software. For this milestone, however, the requirements are a little bit relaxed. A typical user this time will just want to calculate derivatives of a scalar function of a scalar. At a minimum, your software should overload all the basic operations (addition, multiplication, subtraction, division, power). Don't forget about the unary operations such as negation. It should also contain the following elemental functions:

Feel free to go beyond the bare minimum. You'll have to do it eventually before the semester ends.

Test Suite

You should have a test suite that runs with pytest. Your test suite should run automatically on Travis CI. The project GitHub repo should contain a badge showing that your code is passing all of your tests.

You should also have your project connected to Codecov. Once again, the project repo should have a badge reporting on the coverage of your code from Codecov. The repository should reflect at least 90% code coverage. See An introduction to code coverage for a discussion on code coverage.

Documentation

Be sure to extend your documentation from Milestone 1. Now is a good time to think about the best way to distribute your documentation. You may want to consider using a Jupyter notebook with Markdown cells interspersed with code blocks for actual hands-on demos. The same thing can be achieved with a standard Markdown document, but it won't be as interactive.

You will receive full points as long as you have a docs/ folder and your documentation is complete. However, you may want to consider alternative ways of hosting your documentation. For example: Read the Docs or Sphinx.

Documentation Sections

The teaching staff will use the documentation to run your package. They will implement a root-finding algorithm that requires first derivative information. See the section What Kinds of Functions should be Implemented? to get an idea of the types of elementary functions that could be used.

The following sections should be present:

Future Features

Now that you've got most of the hard implementation work done, what kinds of things do you want to implement next? How will your software change? What will be the primary challenges to implementing these new features? Things you may want to consider here include (but are not limited to) any changes to the directory structure, and new modules, classes, data structures, etc.

We are checking for reasonable ideas here. If you really can't come up with anything interesting, you should consult the lecture notes. If you are still lost after that, please ask your TF or the instructor for help. If you are unsure about the viability or difficulty of your proposed extension, please ask your TF or the instructor for their thoughts. The extension should not be trivial and you should have given it sufficient thought that you can write something concrete about how to proceed. Please be creative and have fun with it!

Grading Breakdown

Points Task
2 milestone2 document setup, peer-evaluation form submitted
2 Introduction and background
3 How to use
2 Software Organization
3 Implementation details
3 Future Features
10 Correct implementation of minimum requirements
5 Adaquate testing for minimum project requirements