Initial commit

.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+.DS_Store
+docs/build

README.md

@@ -0,0 +1,5 @@
+# Optimatic   
+A library of implementations of various optimisation algorithms.   
+
+This is just something I'm putting together to learn about optimisation
+algorithms, and isn't really intended for real-world use.

demo.py

@@ -0,0 +1,10 @@
+from optimatic.grad_desc import Optimiser
+import numpy as np
+
+def f(x):
+    return (x - 5.4) ** 2
+
+def df(x):
+    return 2 * (x - 5.4)
+
+opt = Optimiser(f, df, 0.0)

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Optimatic
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/build_docs.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+
+sphinx-apidoc -f -o source ../optimatic
+make html

docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=Optimatic
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,156 @@
+# -*- coding: utf-8 -*-
+#
+# Optimatic documentation build configuration file, created by
+# sphinx-quickstart on Thu Sep 21 14:42:59 2017.
+#
+# This file is execfile()d with the current directory set to its
+# containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import sys
+sys.path.insert(0, os.path.abspath('../..'))
+
+
+# -- General configuration ------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = ['sphinx.ext.autodoc',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.githubpages']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'Optimatic'
+copyright = u'2017, Lewis O\'Driscoll'
+author = u'Lewis O\'Driscoll'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = u'0.0.1'
+# The full version, including alpha/beta/rc tags.
+release = u'0.0.1'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This patterns also effect to html_static_path and html_extra_path
+exclude_patterns = []
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = False
+
+
+# -- Options for HTML output ----------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'pyramid'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+
+# -- Options for HTMLHelp output ------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'Optimaticdoc'
+
+
+# -- Options for LaTeX output ---------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'Optimatic.tex', u'Optimatic Documentation',
+     u'Lewis O\'Driscoll', 'manual'),
+]
+
+
+# -- Options for manual page output ---------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'optimatic', u'Optimatic Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output -------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'Optimatic', u'Optimatic Documentation',
+     author, 'Optimatic', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. Optimatic documentation master file, created by
+   sphinx-quickstart on Thu Sep 21 14:42:59 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Optimatic's documentation!
+=====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   introduction
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/introduction.rst

@@ -0,0 +1,28 @@
+Introduction
+============
+To use optimatic, first define the function you want to optimise:
+
+.. code-block:: python
+
+    def f(x):
+        return (x - 2.4) ** 2
+
+Some optimisation methods (e.g. gradient descent) also require you to define the
+derivative of your function:
+
+.. code-block:: python
+
+    def df(x):
+        return 2 * (x - 2.4)
+
+Then import and initialise the optimiser you want to use, e.g.:
+
+.. code-block:: python
+
+    from optimatic.grad_desc import Optimiser
+    opt = Optimiser(f, df, 6.0)
+
+Then run either :code:`opt.step()` to run one step of the chosen optimisation
+algorithm, or :code:`opt.optimise()` to run until either :code:`opt.steps` is
+exceeded, or :code:`opt.precision` is met. See
+:func:`~optimatic.grad_desc.Optimiser` for more details.

docs/source/modules.rst

@@ -0,0 +1,7 @@
+optimatic
+=========
+
+.. toctree::
+   :maxdepth: 4
+
+   optimatic

docs/source/optimatic.rst

@@ -0,0 +1,29 @@
+optimatic package
+=================
+
+Subpackages
+-----------
+
+.. toctree::
+
+    optimatic.utils
+
+Submodules
+----------
+
+optimatic.grad_desc module
+--------------------------
+
+.. automodule:: optimatic.grad_desc
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: optimatic
+    :members:
+    :undoc-members:
+    :show-inheritance:

docs/source/optimatic.utils.rst

@@ -0,0 +1,22 @@
+optimatic.utils package
+=======================
+
+Submodules
+----------
+
+optimatic.utils.generate module
+-------------------------------
+
+.. automodule:: optimatic.utils.generate
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: optimatic.utils
+    :members:
+    :undoc-members:
+    :show-inheritance: