diff --git a/README.rst b/README.rst index 2329568..a08c288 100644 --- a/README.rst +++ b/README.rst @@ -1,106 +1,4 @@ Hyppopy ======================== -The friendly Hyppo that helps you to find your inner blackbox optimum. - -It is adapted from `this github example `_ -(`Learn more `_) and tries to follow the instructions on `this guide `_. - -The actual code can be found in :py:mod:`samplepackage.thinker`. It implements a toy class -which "thinks" random thoughts. -The tests for this class are located in :py:mod:`samplepackage.tests`. Python will automatically -discover tests if you name them test_*.py -Look at :py:meth:`samplepackage.tests.test_advanced` for a simple unittest example. - -Install Dependencies --------------------- -either use:: - - pip install -r requirements.txt - -or:: - - make init - - -Install This Package --------------------- -You have two choices: - -#. "normal" install. This will install the current version. -#. install a development version. Here the package will be installed, but only as a link to your current codebase. See `here `_ for a better explanation :-) - -After you installed your package, it can be imported via:: - - import samplepackage - -in your python console. - -Install Development Version: -^^^^^^^^^^^^^^^^^^^^^^^^^^^ - -either use:: - - python setup.py develop - -or:: - - make install_develop - -"Normal" Install -^^^^^^^^^^^^^^^ - -either use:: - - python setup.py install - -or:: - - make install - - -run tests --------------------- - -either run:: - - python -m unittest discover - -or:: - - make test - - -execute tutorial --------------------- -In your console, navigate to the tutorials subfolder and start ipython notebook. - - -run scripts --------------------- -Scripts can be found in subfolder bin/. They are declared as entry points -(see setup.py in the project root). This means you can call them by calling the entry points -directly in console! - - -build documentation --------------------- - -First the documentation has to be refreshed by typing:: - - sphinx-apidoc -e -f samplepackage -o doc/ - -or:: - - make documentation - -in the projects root folder (the one with setup.py). This will automatically create -all the files necessary for sphinx (the documentation builder) to create the -html documentation. -Then, navigate to doc/ and type:: - - make html - -To build the documentation. Note that sphinx needs to be available in your python -installation (e.g. install requirements.txt as mentioned above). -The documentation main page can then be found in doc/_build/html/index.html +The friendly Hyppo (HYPer-Parameter-Optimizer) helping you to find your inner blackbox optimum. diff --git a/requirements.txt b/requirements.txt index f1f0aae..75d523a 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,15 +1,50 @@ -# sphinx is used for building the documentation -sphinx - -# xmlrunner is used in tests.py and needed to get nicely formatted output for -# jenkins to interpret. -xmlrunner - -# yapsy is a plugin manager package -yapsy - -# xmltodict is a package for converting xml structure to nested dicts -xmltodict - -# dicttoxml is a package for converting nested dicts to xml structure -dicttoxml +alabaster==0.7.12 +asn1crypto==0.24.0 +atomicwrites==1.2.1 +attrs==18.2.0 +Babel==2.6.0 +certifi==2018.11.29 +cffi==1.11.5 +chardet==3.0.4 +colorama==0.4.1 +cryptography==2.3.1 +decorator==4.3.2 +dicttoxml==1.7.4 +docutils==0.14 +dpath==1.4.2 +future==0.17.1 +hyperopt==0.1.1 +idna==2.8 +imagesize==1.1.0 +Jinja2==2.10 +MarkupSafe==1.1.0 +matplotlib==3.0.2 +more-itertools==5.0.0 +networkx==2.2 +numpy==1.16.0 +Optunity==1.1.1 +packaging==19.0 +pluggy==0.8.1 +py==1.7.0 +pycparser==2.19 +Pygments==2.3.1 +pymongo==3.7.2 +pyOpenSSL==18.0.0 +pyparsing==2.3.1 +PySocks==1.6.8 +pytest==4.1.1 +pytz==2018.9 +requests==2.21.0 +scikit-learn==0.20.2 +scipy==1.2.0 +six==1.12.0 +sklearn==0.0 +snowballstemmer==1.2.1 +Sphinx==1.8.3 +sphinxcontrib-websupport==1.1.0 +urllib3==1.24.1 +win-inet-pton==1.0.1 +wincertstore==0.2 +xmlrunner==1.7.7 +xmltodict==0.11.0 +Yapsy==1.11.223