Docs

CONTRIBUTING.md

@@ -8,7 +8,7 @@ and other resources to make it easier to get your contribution accepted.
 ## Certificate of Origin
 
 By contributing to this project you agree to the [Developer Certificate of
-Origin (DCO)](DCO.md). This document was created by the Linux Kernel community and is a
+Origin (DCO)](https://github.com/FragileTech/ml-ops-quickstart/blob/master/DCO.md). This document was created by the Linux Kernel community and is a
 simple statement that you, as a contributor, have the legal right to make the
 contribution.
 
@@ -40,7 +40,7 @@ In order for a PR to be accepted it needs to pass a list of requirements:
 - Python code is formatted according to [![PEP8](https://img.shields.io/badge/code%20style-pep8-orange.svg)](https://www.python.org/dev/peps/pep-0008/).
 - If the PR is a bug fix, it has to include a new unit test that fails before the patch is merged.
 - If the PR is a new feature, it has to come with a suite of unit tests, that tests the new functionality.
-- In any case, all the PRs have to pass the personal evaluation of at least one of the [maintainers](MAINTAINERS.md).
+- In any case, all the PRs have to pass the personal evaluation of at least one of the maintainers.
 
 
 ### Format of the commit message

docs/Makefile

@@ -27,6 +27,8 @@ server:
 .PHONY: test
 test:
 	rm -rf build
+	rm -rf ./source/assets/*
+	cp -r ../mloq/assets/* source/assets
 	make html
 	make server
 

docs/requirements-docs.txt

@@ -1,4 +1,6 @@
 sphinx==3.4.3
+linkify-it-py==1.0.1
 myst-parser==0.13.3
-sphinx-autoapi==1.6.0
+ruyaml==0.19.2
+sphinx-autoapi==1.7.0
 sphinx-rtd-theme==0.5.1

docs/source/_static/mloq.yml

@@ -0,0 +1,13 @@
+project_name: "{{project_name}}"
+default_branch: "{{default_branch}}"
+owner: "{{owner}}"
+author: "{{author}}"
+email: "{{email}}"
+copyright_holder: "{{copyright_holder}}"
+project_url: "{{project_url}}"
+bot_name: "{{bot_name}}"
+bot_email: "{{bot_email}}"
+license: "{{license}}"
+description: "{{description}}"
+python_versions: "{{python_versions}}"
+docker_image: "{{docker_image}}"

docs/source/assets/requirements/data-science.txt

@@ -0,0 +1,8 @@
+networkx==2.5
+numba==0.52.0
+numpy==1.19.4
+opencv-python==4.4.0.46
+pandas==1.1.5
+pillow-simd==7.0.0.post3
+scipy==1.5.4
+scikit-learn==0.24.0

docs/source/assets/requirements/data-visualization.txt

@@ -0,0 +1,9 @@
+bokeh==2.2.3
+holoviews==1.14.0
+hvplot==0.7.0
+matplotlib==3.3.3
+panel==0.10.2
+param==1.10.0
+plotly==4.14.1
+selenium==3.141.0
+streamz==0.6.1

docs/source/assets/requirements/pytorch.txt

@@ -0,0 +1,4 @@
+torch==1.7.1
+torchvision==0.8.2
+einops==0.3.0
+pytorch-lightning==1.1.4

docs/source/assets/requirements/requirements-lint.txt

@@ -0,0 +1,10 @@
+black ==19.10b0
+flake8==3.8.4
+flake8-bugbear==20.11.1
+flake8-docstrings==1.5.0
+flake8-import-order==0.18.1
+flake8-quotes==3.2.0
+isort==5.6.4
+pylint==2.6.0
+pydocstyle==5.1.1
+flakehell==0.7.1

docs/source/assets/requirements/requirements-test.txt

@@ -0,0 +1,5 @@
+psutil==5.8.0
+pytest==6.2.1
+pytest-cov==2.11.1
+pytest-xdist==2.2.0
+hypothesis==6.0.3

docs/source/assets/requirements/tensorflow.txt

@@ -0,0 +1 @@
+tensorflow==2.4.0

docs/source/assets/static/.gitignore

@@ -0,0 +1,129 @@
+
+#Mac OS
+*.DS_Store
+
+#PyCharm IDE
+.idea/
+
+# Documentation build templates
+doc/_build/
+doc/ast2vec.rst
+doc/modules.rst
+
+# Byte-compiled / optimized / DLL templates
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these templates are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docsrc/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed templates
+*.sage.py
+
+# dotenv
+.env
+
+# virtualenv
+.venv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# CI
+.ci
+
+# Notebooks by default are ignored
+*.ipynb
+
+data/
+
+docs/
+examples/
+*.pck
+*.npy
+
+Pipfile.lock

docs/source/assets/static/DCO.md

@@ -0,0 +1,36 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+660 York Street, Suite 102,
+San Francisco, CA 94110 USA
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+By making a contribution to this project, I certify that:
+
+(a) The contribution was created in whole or in part by me and I
+    have the right to submit it under the open source license
+    indicated in the file; or
+
+(b) The contribution is based upon previous work that, to the best
+    of my knowledge, is covered under an appropriate open source
+    license and I have the right under that license to submit that
+    work with modifications, whether created in whole or in part
+    by me, under the same open source license (unless I am
+    permitted to submit under a different license), as indicated
+    in the file; or
+
+(c) The contribution was provided directly to me by some other
+    person who certified (a), (b) or (c) and I have not modified
+    it.
+
+(d) I understand and agree that this project and the contribution
+    are public and that a record of the contribution (including all
+    personal information I submit with it, including my sign-off) is
+    maintained indefinitely and may be redistributed consistent with
+this project or the open source license(s) involved.

docs/source/assets/static/Dockerfile_aarch64

@@ -0,0 +1,11 @@
+FROM quay.io/pypa/manylinux2014_aarch64 as build
+
+ENV PLAT=manylinux2014_aarch64
+RUN mkdir -p /io/
+COPY . /io/
+WORKDIR /io/
+
+RUN ./scripts/build-manylinux-wheels.sh
+
+FROM scratch as release
+COPY --from=build /io/dist /wheelhouse

docs/source/assets/static/build-manylinux-wheels.sh

@@ -0,0 +1,43 @@
+#!/bin/bash
+set -e -x
+
+# This is to be run by Docker inside a Docker image.
+# You can test it locally on a Linux machine by installing Docker and running from this
+# repo's root:
+# $ docker run -e PLAT=manylinux1_x86_64 -v `pwd`:/io quay.io/pypa/manylinux1_x86_64 /io/scripts/build-manylinux-wheels.sh
+
+# The -e just defines an environment variable PLAT=[docker name] inside the Docker:
+# auditwheel can't detect the Docker name automatically.
+
+# The -v gives a directory alias for passing files in and out of the Docker.
+# (/io is arbitrary). E.g the setup.py script can be accessed in the Docker via
+# /io/setup.py quay.io/pypa/manylinux1_x86_64 is the full Docker image name. Docker
+# downloads it automatically.
+
+# The last argument is a shell command that the Docker will execute. Filenames must be
+# from the Docker's perspective.
+
+# Wheels are initially generated as you would usually, but put in a temp directory temp-wheels.
+# The pip-cache is optional but can speed up local builds having a real permanent pip-cache dir.
+mkdir -p /io/pip-cache
+mkdir -p /io/temp-wheels
+
+# Clean out any old existing wheels.
+find /io/temp-wheels/ -type f -delete
+
+for PYBIN in /opt/python/cp3[6789]*/bin; do
+    "${PYBIN}/pip" install -q -U setuptools wheel pytest --cache-dir /io/pip-cache
+    (cd /io/ && "${PYBIN}/python" -m pip install .)
+    (cd /io/ && "${PYBIN}/python" -m pytest)
+    (cd /io/ && "${PYBIN}/python" setup.py -q bdist_wheel -d /io/temp-wheels)
+done
+
+"$PYBIN/pip" install -q auditwheel
+
+# Wheels aren't considered manylinux unless they have been through
+# auditwheel. Audited wheels go in /io/dist/.
+mkdir -p /io/dist/
+
+for whl in /io/temp-wheels/*.whl; do
+    auditwheel repair "$whl" --plat $PLAT -w /io/dist/
+done

docs/source/assets/static/main.txt

@@ -0,0 +1,9 @@
+import sys
+
+
+def main():
+    return 0
+
+
+if __name__ == "__main__":
+    sys.exit(main())

docs/source/assets/static/mloq.yml

@@ -0,0 +1,32 @@
+# This yaml file contains all the information used by mloq to set up a new project.
+# All values are strings, except `python_versions` and `requirements`
+# that are lists of strings.
+# `null` values are interpreted as missing values.
+# ------------------------------------------------------------------------------
+
+# `template` contains all the values that will be written in the generated files.
+# They are loaded as a dictionary and passed to jinja2 to fill in the templates.
+project_config:
+  open_source: null  # boolean
+  docker: null  # boolean
+  ci: null  # string
+  mlflow: null #boolean
+  requirements: null # list
+
+template:
+  project_name: null
+  default_branch: null
+  owner: null
+  author: null
+  email: null
+  copyright_holder: null
+  project_url: null
+  bot_name: null
+  bot_email: null
+  license: null
+  description: null
+  python_versions: null
+  docker_image: null
+
+
+

docs/source/assets/static/version.txt

@@ -0,0 +1,2 @@
+"""Current version of the project. Do not modify manually."""
+__version__ = "0.0.0"