Metadata-Version: 2.1
Name: spirograph
Version: 0.0.0
Summary: A tool to help building ML pipeline easier for non technical users..
Home-page: https://github.com/mcgill-cpslab/spiral
License: Apache-2.0
Author: Yuecai Zhu
Author-email: zhuyuecai@gmail.com
Requires-Python: >=3.7,<3.10
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: dev
Provides-Extra: doc
Provides-Extra: test
Requires-Dist: black (>=21.5b2,<22.0); extra == "test"
Requires-Dist: bump2version (>=1.0.1,<2.0.0); extra == "dev"
Requires-Dist: click (==8.0.1)
Requires-Dist: dgl (>=0.6,<0.9)
Requires-Dist: findspark (>=2.0.1,<3.0.0)
Requires-Dist: flake8 (>=3.9.2,<4.0.0); extra == "test"
Requires-Dist: flake8-docstrings (>=1.6.0,<2.0.0); extra == "test"
Requires-Dist: isort (>=5.8.0,<6.0.0); extra == "test"
Requires-Dist: jinja2 (==3.0.0); extra == "doc"
Requires-Dist: mkdocs (==1.2.3); extra == "doc"
Requires-Dist: mkdocs-autorefs (>=0.2.1,<0.3.0); extra == "doc"
Requires-Dist: mkdocs-include-markdown-plugin (>=1.0.0,<2.0.0); extra == "doc"
Requires-Dist: mkdocs-material (>=6.1.7,<7.0.0); extra == "doc"
Requires-Dist: mkdocs-material-extensions (>=1.0.1,<2.0.0)
Requires-Dist: mkdocstrings (>=0.15.2,<0.16.0); extra == "doc"
Requires-Dist: mypy (==0.961); extra == "test"
Requires-Dist: ogb (>=1.3.2,<2.0.0)
Requires-Dist: pip (>=20.3.1,<21.0.0); extra == "dev"
Requires-Dist: pre-commit (>=2.12.0,<3.0.0); extra == "dev"
Requires-Dist: py7zr (>=0.17,<0.18); extra == "dev"
Requires-Dist: pygments (==2.11.0)
Requires-Dist: pyspark (>=3.2.1,<4.0.0)
Requires-Dist: pytest (>=6.2.4,<7.0.0); extra == "test"
Requires-Dist: pytest-cov (>=2.12.0,<3.0.0); extra == "test"
Requires-Dist: tensorflow (>=2.7.0,<2.9); extra == "dev"
Requires-Dist: toml (>=0.10.2,<0.11.0); extra == "dev"
Requires-Dist: torch (==1.10.2); extra == "dev"
Requires-Dist: tox (>=3.20.1,<4.0.0); extra == "dev"
Requires-Dist: twine (>=3.3.0,<4.0.0); extra == "dev"
Requires-Dist: virtualenv (>=20.2.2,<21.0.0); extra == "dev"
Description-Content-Type: text/markdown

# spirograph


[![pypi](https://img.shields.io/pypi/v/spirograph.svg)](https://pypi.org/project/spirograph/)
[![python](https://img.shields.io/pypi/pyversions/spirograph.svg)](https://pypi.org/project/spirograph/)
[![Build Status](https://github.com/mcgill-cpslab/spiral/actions/workflows/dev.yml/badge.svg)](https://github.com/mcgill-cpslab/spiral/actions/workflows/dev.yml)
[![codecov](https://codecov.io/gh/mcgill-cpslab/spiral/branch/main/graphs/badge.svg)](https://codecov.io/github/mcgill-cpslab/spiral)



A tool to help building ML pipeline easier for non technical users.


* Documentation: <https://mcgill-cpslab.github.io/spiral>
* GitHub: <https://github.com/mcgill-cpslab/spiral>
* PyPI: <https://pypi.org/project/spirograph/>
* Free software: Apache-2.0

## Architecture and road map

The following image shows the overall architecture design of spirograph:
![alt text](https://github.com/mcgill-cpslab/spiral/blob/master/imgs/architecture.png?raw=true)

And here will be the spirograph application design. Some names are out of dated, need further modification.
![alt text](https://github.com/mcgill-cpslab/spiral/blob/master/imgs/dygraph_app-app.png?raw=true)


## Features

* TODO

## Credits

This package was created with [Cookiecutter](https://github.com/audreyr/cookiecutter) and the [waynerv/cookiecutter-pypackage](https://github.com/waynerv/cookiecutter-pypackage) project template.

