Skip to content

Commit d1e02f2

Browse files
RenhaoLRenhaoL
authored
Merge pull request #35 from cs107-undefined/final_milestone
Final milestone
2 parents 3071cb6 + 3060934 commit d1e02f2

File tree

156 files changed

+35949
-632
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

156 files changed

+35949
-632
lines changed

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,16 @@
33
# Ignore ipynb checkpoints
44
.ipynb_checkpoints
55
.idea
6+
.vscode
67
test/__pycache__/
78
src/undefined/__pycache__/
89

910
# ignore the .coverage files
1011
coverage.xml
1112
.coverage
13+
14+
# ignore the coverage html
15+
htmlcov
16+
17+
# ignore the computational graph generated from testing
18+
*.png

‎.readthedocs.yaml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
# .readthedocs.yaml
2+
# Read the Docs configuration file
3+
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4+
5+
# Required
6+
version: 2
7+
8+
# Set the version of Python and other tools you might need
9+
build:
10+
os: ubuntu-20.04
11+
tools:
12+
python: "3.9"
13+
# You can also specify other tool versions:
14+
# nodejs: "16"
15+
# rust: "1.55"
16+
# golang: "1.17"
17+
18+
# Build documentation in the docs/ directory with Sphinx
19+
sphinx:
20+
configuration: docs/documentation/conf.py
21+
22+
# If using Sphinx, optionally build your docs in additional formats such as PDF
23+
# formats:
24+
# - pdf
25+
26+
# Optionally declare the Python requirements required to build your docs
27+
python:
28+
install:
29+
- requirements: requirements.txt

‎.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
language: python
22
python:
3-
- "3.6"
3+
- "3.8"
44
before_install:
55
- pip install codecov
66
- pip install coverage

‎.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"restructuredtext.confPath": "${workspaceFolder}/docs"
3+
}

‎README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,21 @@
1-
# cs107-FinalProject
1+
# Undefined_AD Package
22

3-
[![Build Status](https://app.travis-ci.com/cs107-undefined/cs107-FinalProject.svg?branch=milestone2)](https://app.travis-ci.com/cs107-undefined/cs107-FinalProject)
3+
[**Undefined_AD Documentation**](https://cs107-undefined.readthedocs.io/en/latest/)
44

5-
[![codecov](https://codecov.io/gh/cs107-undefined/cs107-FinalProject/branch/milestone2/graph/badge.svg?token=MWEZONI94C)](https://codecov.io/gh/cs107-undefined/cs107-FinalProject)
5+
[![Build Status](https://app.travis-ci.com/cs107-undefined/cs107-FinalProject.svg?branch=final_milestone)](https://app.travis-ci.com/cs107-undefined/cs107-FinalProject) [![codecov](https://codecov.io/gh/cs107-undefined/cs107-FinalProject/branch/final_milestone/graph/badge.svg?token=MWEZONI94C)](https://codecov.io/gh/cs107-undefined/cs107-FinalProject)
6+
7+
[![Documentation Status](https://readthedocs.org/projects/cs107-undefined/badge/?version=latest)](https://cs107-undefined.readthedocs.io/en/latest/?badge=latest)
8+
9+
10+
## Brief Introduction
11+
12+
This project/package is part of the Harvard CS107/AC207 class final project in Fall 2021, automatic differentiation (AD). We created this package to compute the first-order derivative from a user-defined function automatically. Our package can utilize both forward and reverse modes. Additionally, we also allow users to define their own seeds vector for the Jacobian Matrix and the option to generate the computational graph associated with the input function.
13+
14+
To install, run the following command in your terminal
15+
16+
`pip install undefined_AD`
17+
18+
For details instruction on how to use this package, please follow the steps in the [usage page](https://cs107-undefined.readthedocs.io/en/latest/usage.html).
619

720
**Group Number:**
821

@@ -17,3 +30,5 @@ _Renhao Luo [email protected]_
1730
_Chelse Swoopes [email protected]_
1831

1932
_Shijia Zhang [email protected]_
33+
34+
Harvard University, Fall 2021

‎dist/undefined-1.0.0-py3-none-any.whl

-6.57 KB
Binary file not shown.

‎dist/undefined-1.0.0.tar.gz

-7.6 KB
Binary file not shown.

‎dist/undefined_AD-2.1.0-py3-none-any.whl

14.2 KB
Binary file not shown.

‎dist/undefined_AD-2.1.0.tar.gz

21.5 KB
Binary file not shown.

‎docs/documentation/Makefile

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = .
9+
BUILDDIR = _build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎docs/documentation/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Documentation
2+
3+
This directory is used to organize documentation and tutorials for the final package.
4+
5+
Updates log:
6+
7+
10/18/21: Milestone 1 doc is in preparation
8+
9+
10/19/21: Modify directory structure and add LICENSE
10+
11+
10/20/21: Add the initial draft for the implementation
12+
13+
11/2/21: Upated the milestone 1 based on TF's comments.
14+
15+
11/10/21: Add the initial draft for milestone2 documentation.
16+
17+
12/8/21: Add the sphinx file/html.

‎docs/documentation/_build/doctrees/README.doctree

4.31 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/about.doctree

19.7 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/cs107-FinalProject.doctree

4.37 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/cs107-FinalProject.test.doctree

4.38 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/environment.pickle

145 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/implementation.doctree

45.6 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/index.doctree

11.7 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/modules.doctree

2.56 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/organization.doctree

33.8 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/about.doctree

19.1 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/implementation.doctree

46.6 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/index.doctree

12.6 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/modules.doctree

2.63 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/organization.doctree

25.3 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/undefined.doctree

158 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/sphinx_files/usage.doctree

45.3 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/statement.doctree

7.71 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/undefined.doctree

161 KB
Binary file not shown.

‎docs/documentation/_build/doctrees/usage.doctree

54 KB
Binary file not shown.

‎docs/documentation/_build/html/.buildinfo

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: 7531c1d684b02134b6a918ab40d18fca
4+
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/documentation/_build/html/README.html

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="" >
3+
<head>
4+
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17: http://docutils.sourceforge.net/" />
5+
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Documentation &mdash; Undefined - an automatic differentiation tool 1.0.0 documentation</title>
8+
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
9+
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
10+
<!--[if lt IE 9]>
11+
<script src="_static/js/html5shiv.min.js"></script>
12+
<![endif]-->
13+
14+
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
15+
<script src="_static/jquery.js"></script>
16+
<script src="_static/underscore.js"></script>
17+
<script src="_static/doctools.js"></script>
18+
<script src="_static/js/theme.js"></script>
19+
<link rel="author" title="About these documents" href="about.html" />
20+
<link rel="index" title="Index" href="genindex.html" />
21+
<link rel="search" title="Search" href="search.html" />
22+
</head>
23+
24+
<body class="wy-body-for-nav">
25+
<div class="wy-grid-for-nav">
26+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
27+
<div class="wy-side-scroll">
28+
<div class="wy-side-nav-search" >
29+
<a href="index.html" class="icon icon-home"> Undefined - an automatic differentiation tool
30+
</a>
31+
<div role="search">
32+
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
33+
<input type="text" name="q" placeholder="Search docs" />
34+
<input type="hidden" name="check_keywords" value="yes" />
35+
<input type="hidden" name="area" value="default" />
36+
</form>
37+
</div>
38+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
39+
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
40+
<ul>
41+
<li class="toctree-l1"><a class="reference internal" href="about.html">About</a></li>
42+
</ul>
43+
<p class="caption" role="heading"><span class="caption-text">code docstrings:</span></p>
44+
<ul>
45+
<li class="toctree-l1"><a class="reference internal" href="modules.html">undefined</a></li>
46+
</ul>
47+
48+
</div>
49+
</div>
50+
</nav>
51+
52+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
53+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
54+
<a href="index.html">Undefined - an automatic differentiation tool</a>
55+
</nav>
56+
57+
<div class="wy-nav-content">
58+
<div class="rst-content">
59+
<div role="navigation" aria-label="Page navigation">
60+
<ul class="wy-breadcrumbs">
61+
<li><a href="index.html" class="icon icon-home"></a> &raquo;</li>
62+
<li>Documentation</li>
63+
<li class="wy-breadcrumbs-aside">
64+
<a href="_sources/README.md.txt" rel="nofollow"> View page source</a>
65+
</li>
66+
</ul>
67+
<hr/>
68+
</div>
69+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
70+
<div itemprop="articleBody">
71+
72+
<section class="tex2jax_ignore mathjax_ignore" id="documentation">
73+
<h1>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline"></a></h1>
74+
<p>This directory is used to organize documentation and tutorials for the final package.</p>
75+
<p>Updates log:</p>
76+
<p>10/18/21: Milestone 1 doc is in preparation</p>
77+
<p>10/19/21: Modify directory structure and add LICENSE</p>
78+
<p>10/20/21: Add the initial draft for the implementation</p>
79+
<p>11/2/21: Upated the milestone 1 based on TF’s comments.</p>
80+
<p>11/10/21: Add the initial draft for milestone2 documentation.</p>
81+
</section>
82+
83+
84+
</div>
85+
</div>
86+
<footer>
87+
88+
<hr/>
89+
90+
<div role="contentinfo">
91+
<p>&#169; Copyright 2021, Xinran Tang, Renhao Luo, Chelse Swoopes, Shijia Zhang.</p>
92+
</div>
93+
94+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
95+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
96+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
97+
98+
99+
</footer>
100+
</div>
101+
</div>
102+
</section>
103+
</div>
104+
<script>
105+
jQuery(function () {
106+
SphinxRtdTheme.Navigation.enable(true);
107+
});
108+
</script>
109+
110+
</body>
111+
</html>

‎docs/documentation/_build/html/_modules/index.html

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
<!DOCTYPE html>
2+
<html class="writer-html5" lang="" >
3+
<head>
4+
<meta charset="utf-8" />
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
6+
<title>Overview: module code &mdash; Undefined - an automatic differentiation tool 2.0.2 documentation</title>
7+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
8+
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
9+
<link rel="stylesheet" href="../_static/tabs.css" type="text/css" />
10+
<!--[if lt IE 9]>
11+
<script src="../_static/js/html5shiv.min.js"></script>
12+
<![endif]-->
13+
14+
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
15+
<script src="../_static/jquery.js"></script>
16+
<script src="../_static/underscore.js"></script>
17+
<script src="../_static/doctools.js"></script>
18+
<script src="../_static/tabs.js"></script>
19+
<script src="../_static/js/theme.js"></script>
20+
<link rel="author" title="About these documents" href="../about.html" />
21+
<link rel="index" title="Index" href="../genindex.html" />
22+
<link rel="search" title="Search" href="../search.html" />
23+
</head>
24+
25+
<body class="wy-body-for-nav">
26+
<div class="wy-grid-for-nav">
27+
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
28+
<div class="wy-side-scroll">
29+
<div class="wy-side-nav-search" >
30+
<a href="../index.html" class="icon icon-home"> Undefined - an automatic differentiation tool
31+
</a>
32+
<div role="search">
33+
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
34+
<input type="text" name="q" placeholder="Search docs" />
35+
<input type="hidden" name="check_keywords" value="yes" />
36+
<input type="hidden" name="area" value="default" />
37+
</form>
38+
</div>
39+
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
40+
<p class="caption" role="heading"><span class="caption-text">Introduction and Background</span></p>
41+
<ul>
42+
<li class="toctree-l1"><a class="reference internal" href="../about.html">About</a></li>
43+
</ul>
44+
<p class="caption" role="heading"><span class="caption-text">Getting started</span></p>
45+
<ul>
46+
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Usage</a></li>
47+
</ul>
48+
<p class="caption" role="heading"><span class="caption-text">Software Organization</span></p>
49+
<ul>
50+
<li class="toctree-l1"><a class="reference internal" href="../organization.html">Testing and Software Organization</a></li>
51+
</ul>
52+
<p class="caption" role="heading"><span class="caption-text">Implementation</span></p>
53+
<ul>
54+
<li class="toctree-l1"><a class="reference internal" href="../implementation.html">Implementation</a></li>
55+
</ul>
56+
<p class="caption" role="heading"><span class="caption-text">Broader Impact and Future Directions</span></p>
57+
<ul>
58+
<li class="toctree-l1"><a class="reference internal" href="../statement.html">Broader Impact and Future Directions</a></li>
59+
</ul>
60+
<p class="caption" role="heading"><span class="caption-text">Code details</span></p>
61+
<ul>
62+
<li class="toctree-l1"><a class="reference internal" href="../modules.html">undefined</a></li>
63+
</ul>
64+
65+
</div>
66+
</div>
67+
</nav>
68+
69+
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
70+
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
71+
<a href="../index.html">Undefined - an automatic differentiation tool</a>
72+
</nav>
73+
74+
<div class="wy-nav-content">
75+
<div class="rst-content">
76+
<div role="navigation" aria-label="Page navigation">
77+
<ul class="wy-breadcrumbs">
78+
<li><a href="../index.html" class="icon icon-home"></a> &raquo;</li>
79+
<li>Overview: module code</li>
80+
<li class="wy-breadcrumbs-aside">
81+
</li>
82+
</ul>
83+
<hr/>
84+
</div>
85+
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
86+
<div itemprop="articleBody">
87+
88+
<h1>All modules for which code is available</h1>
89+
<ul><li><a href="undefined/API.html">undefined.API</a></li>
90+
<li><a href="undefined/Calculator.html">undefined.Calculator</a></li>
91+
<li><a href="undefined/GraphGenerator.html">undefined.GraphGenerator</a></li>
92+
<li><a href="undefined/UDFunction.html">undefined.UDFunction</a></li>
93+
<li><a href="undefined/Utils.html">undefined.Utils</a></li>
94+
</ul>
95+
96+
</div>
97+
</div>
98+
<footer>
99+
100+
<hr/>
101+
102+
<div role="contentinfo">
103+
<p>&#169; Copyright 2021, Xinran Tang, Renhao Luo, Chelse Swoopes, Shijia Zhang.</p>
104+
</div>
105+
106+
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
107+
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
108+
provided by <a href="https://readthedocs.org">Read the Docs</a>.
109+
110+
111+
</footer>
112+
</div>
113+
</div>
114+
</section>
115+
</div>
116+
<script>
117+
jQuery(function () {
118+
SphinxRtdTheme.Navigation.enable(true);
119+
});
120+
</script>
121+
122+
</body>
123+
</html>

0 commit comments

Comments
 (0)