diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..1d7aec2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,140 @@ + +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files 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/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments +.env +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ +*.DS_Store diff --git a/README.md b/README.md index 9ac6d9e..5639220 100644 --- a/README.md +++ b/README.md @@ -131,3 +131,17 @@ If you have ideas/feedback, feel free to open an issue. +# Installation +Until this is up on pypi, this can either be installed via cloning the package: + +``` +git clone https://github.com/lessw2020/Ranger21.git +cd Ranger21 +python -m pip install -e . +``` + +or directly installed from github: + +``` +python -m pip install git+https://github.com/lessw2020/Ranger21.git +``` diff --git a/ranger21/__init__.py b/ranger21/__init__.py new file mode 100644 index 0000000..ed1de06 --- /dev/null +++ b/ranger21/__init__.py @@ -0,0 +1,2 @@ +from .ranger21 import Ranger21 +from .rangerabel import Ranger21abel diff --git a/src/chebyshev_lr_functions.py b/ranger21/chebyshev_lr_functions.py similarity index 100% rename from src/chebyshev_lr_functions.py rename to ranger21/chebyshev_lr_functions.py diff --git a/src/Ranger21.py b/ranger21/ranger21.py similarity index 100% rename from src/Ranger21.py rename to ranger21/ranger21.py diff --git a/src/Rangerabel.py b/ranger21/rangerabel.py similarity index 100% rename from src/Rangerabel.py rename to ranger21/rangerabel.py diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..7dda172 --- /dev/null +++ b/setup.py @@ -0,0 +1,25 @@ +import setuptools + + +with open("README.md", "r", encoding="utf-8") as f: + long_description = f.read() + +setuptools.setup( + name="ranger21", + version="0.0.1", + author="lessw2020", + description="Integrating the latest deep learning components into a single optimizer", + long_description=long_description, + long_description_content_type="text/markdown", + url=f"https://github.com/lessw2020/Ranger21", + project_urls={ + "Bug Tracker": f"https://github.com/lessw2020/Ranger21/issues", + }, + classifiers=[ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: Apache 2.0 License", + "Operating System :: OS Independent", + ], + packages=["ranger21"], + python_requires=">=3.6", +) diff --git a/src/__pycache__/Ranger21.cpython-37.pyc b/src/__pycache__/Ranger21.cpython-37.pyc deleted file mode 100644 index b2d67e9..0000000 Binary files a/src/__pycache__/Ranger21.cpython-37.pyc and /dev/null differ diff --git a/src/__pycache__/Rangerabel.cpython-37.pyc b/src/__pycache__/Rangerabel.cpython-37.pyc deleted file mode 100644 index 205fc8b..0000000 Binary files a/src/__pycache__/Rangerabel.cpython-37.pyc and /dev/null differ