Final Deliverables

Due: Tuesday, December 10th 2019 at 12:00 PM (noon)

Submission Instructions

Your project should be available in your GitHub organization through your project repo.

Your submission should be in the following format:

project_repo/
             README.md
             docs/  
                  documentation
                  milestone1
                  milestone2
             code/
                 ...

Note that code should be named something informative.

Software Requirements

Here are the main requirements for the final project:

1. Working forward mode implementation
   • See the sections below for more specific details
2. Test suite
3. Updated / extended documentation
   • Your updated documentation will be the final package documentation.
   • Please name it documentation. Do not name it milestone3.
4. New features

Working Forward Mode Implementation

You must have a working forward mode implementation.

• Your library should be able to handle real functions of one or more variables. This includes the situation where a user might have multiple functions each of multiple variables.
• Your library should be able to handle vector functions with multiple real scalar or vector inputs.

Minimum Package Requirements

• The software should be available for download from your GitHub organization.
• The software should also be installable from PyPI.
• You should provide a requirements.txt file (or something equivalent) with your software so other developers are able to install the necessary dependencies.
• After a user installs your package, they should be able to use it without difficulty.

Minimum Implementation Requirements

The following is a description of a typical use case.

• A user downloads your package from your organization or through PyPI.
• They install the dependencies.
• They run the tests if they're a fellow developer.
• They create a "driver" script in the top level.
• Note: How they interact with your package will depend on your implementation. The interface and other implementation details should be described in your documentation.
• The next few steps may sound somewhat abstract, but that is only because they hinge on your specific implementation.
• In the driver script, they import your package.
• They instantiate an automatic differentiation object to be used in the forward mode.
• They use the automatic differentiation objects in their own applications (root-finding, optimization, etc).

What Kinds of Functions should be Implemented?

All basic operations and elementary functions should be implemented.

Basic Operations

• Addition (commutative)
• Subtraction
• Multiplication (commutative)
• Division
• Power
• Negation

Comparison Operators

It is up to you which comparison operators to implement. Here are some options:

• __lt__ (less than)
• __gt__ (greater than)
• __le__ (less than or equal to)
• __ge__ (greater than or equal to)
• __eq__ (equal to)
• __ne__ (not equal to)

At the very least, it makes sense to have __eq__ and __ne__. We will be interested to see what (if any) uses you find for the other operators.

Elementary Functions

• Trig functions (at the very least, you must have sine, cosine, tangent)
• Inverse trig functions (e.g. arcsine, arccosine, arctangent)
• Exponentials
  • Should be able to handle any base
  • You can treat the natural base (e) as a special case
    • This is what numpy does.
• Hyperbolic functions (sinh, cosh, tanh)
  • Note that these can be formed from the natural exponential (e)
• Logistic function
  • Again, this can be formed from the natural exponential
• Logarithms
  • Should be able to handle any base.
• Square root

Note that the hyperbolic functions and the logistic function are arguably not elemental functions since they can be formed from the natural exponential. On the other hand, they do form a key ingredient in some algorithms (e.g. neural networks) and can therefore be considered as elemental functions. You should implement these functions.

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 the pass/fail status of your build. The badge should show that your build is passing all 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. Remember: Your code coverage should be at least 90%.

Documentation

Your documentation must be complete, easy to navigate, and clear. Remember to update the Background and How to Use sections of your documentation as you add more functionality to your package, so that the user has a good understanding of what he/she can do. Call the final form of your documentation documentation.

Your documentation should be a mix of text and hands-on demos. As always, it is up to you and your group to determine the best way to accomplish this (e.g. Jupyter notebook, GitHub README, Sphinx/Read the Docs).

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 following sections should be present:

• Introduction
  • Describe the problem the software solves and why it is important to solve that problem. This can be built off of the milestones, but you may need to update it depending on what new feature you proposed.
• Background
  • The automatic differentiation background can probably stay the same as in the milestones, unless you were told to update it considerably.
  • Be sure to include any necessary background for your new feature.
• How to use your package
  • How to install?
  • Include a basic demo for the user. This can be based off of the milestone, but it may change depending on what your new feature is.
    • You may want to consider more than one basic demo: one demo just for automatic differentiation and and one demo for your new feature.
    • Note that this is very much dependent on your final deliverable!
    • Keep the basic demos to a manageable number.
• Software organization
  • High-level overview of how the software is organized.
    • Directory structure
    • Basic modules and what they do
    • Where do the tests live? How are they run? How are they integrated?
    • How can someone install your package? Should developers and consumers follow a different installation procedure?
• Implementation details
  • Description of current implementation. This section goes deeper than the high level software organization section.
    • Try to think about the following:
      • Core data structures
      • Core classes
      • Important attributes
      • External dependencies
      • Elementary functions
• Your extension
  • Description of your extension (the feature(s) you implemented in addition to the minimum requirements.)
  • Additional information or background needed to understand your extension
    • This could include required mathematics or other concepts

Future

What else do you want to add? What is missing? Don't just think about mathematical things here. Try to think about applications that you'd like to have use your code. Just about every area of science can use automatic differentiation (physics, biology, genetics, applied mathematics, optimization, statistics / machine learning, health science, etc).

Final Deliverables

The deliverable for the project is a video that describes all of the work done on your project throughout the semester. You are free to decide upon the format of the video yourself (with some restrictions - see below).

Some ideas include:

• an actual video of your group presenting in front of a screen
• a narrated video of a powerpoint with diagrams and illustrations
• a narrated live code demo
• a mix of all of the above

You may want to consider tools such as asciinema.

We won't be judging you on the quality of your camera or your video editing ability so don't worry about that. We will judge you only on the content you present. However, if the quality of the video is so poor as to prevent us from judging the quality of the work, then we will unfortunately need to deduct points.

Video Requirements

• The video should be narrated by all members of your group.
• Every group member should speak an equal amount in the video.
• For a group of n people, you should change speakers exactly n-1 times. (i.e. you should all speak exactly once during the video - you shouldn't continuously change who is speaking).
• The Introduction / Background and Implementation details/Software organization/How to use sections should contain information related to the minimum project requirements only.
• If you want to provide additional Introduction / Background or Implementation details/software organization/how to use for your extension to the project, you should do this in the Your additional feature(s) and extension section of the video.

Video Submission instructions

• Your video should be uploaded to YouTube as a private video.
• Share your video with all of the teaching staff on YouTube. Click here for a list of our emails.
  • See here for instructions on how to share a private video.
• If you do not want to upload your video to YouTube, you can alternatively submit it on Canvas.
• You should fill out the video submission Google form which will be sent out by email.
• Your video should be at maximum 15 minutes.
  • WARNING: DO NOT exceed the time! We will not grade portions of your project that exceed the time.
• Make sure the title of your video includes your group number.

Things to keep in mind

• Remember, the teaching staff already has full access to your code, so there is no need to focus on small implementation details.
  • DO NOT include snippets of your actual library code in your presentation!
• Pseudo-code and flowcharts can be very useful to give the big idea of how your package works.
• Library demos can be very useful, but be careful. If they don't work well then you'll waste all your video time.
• You should provide sufficient background for the project.
  • Don't overdo the mathematical details for automatic differentation. We are already familiar with them.
  • Instead, provide the big ideas behind automatic differentation and the motivation for using it.
• Spend a fair bit of time on your new feature.
  • You may need to present some mathematical background to get your audience oriented.
• Be sure to conclude with future work and possible extensions.

Grading Breakdown