Skip to content
This repository has been archived by the owner on Jun 14, 2023. It is now read-only.

Commit

Permalink
start working on cookiecutter-template description
Browse files Browse the repository at this point in the history
  • Loading branch information
valentin.kozlov committed Jan 10, 2019
1 parent aa38512 commit b43992e
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
2 changes: 1 addition & 1 deletion source/user/models/index.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Examples
Models
========

.. toctree::
Expand Down
36 changes: 36 additions & 0 deletions source/user/overview/cookiecutter-template.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,38 @@
Repository template
===================

To simplify development and in easy way integrate your model with DEEPaaS API,
a project template, `cookiecutter-data-science <https://github.com/indigo-dc/cookiecutter-data-science>`_ [*]_, is provided in our GitHub.

In order to create your project based on the template, one has to `install <https://cookiecutter.readthedocs.io/en/latest/installation.html>`_ and then run
`cookicutter <https://cookiecutter.readthedocs.io/en/latest/>`_ tool as follows::

$ cookiecutter https://github.com/indigo-dc/cookiecutter-data-science
You will be asked several questions, e.g.:

* User account at github.com, e.g. 'indigo-dc'
* Project name
* Repository name for the new project
* (main) author name
* Email of the author (or contact person)
* Short description of the project
* Application version
* Choose open source license
* Version of python interpreter
* Docker Hub account name
* Base image for Dockerfile

.. note:: These parameters are defined in cookiecutter.json in the `cookiecutter-data-science <https://github.com/indigo-dc/cookiecutter-data-science>`_ source.

When these questions are answered, following two repositories will be created locally and immediately linked to your github.com account::

~/DEEP-OC-your_project
~/your_project




------------------

.. [*] A more general `cockiecutter-data-science <http://drivendata.github.io/cookiecutter-data-science/>`_ template was adapted for the purpose of DEEP.
2 changes: 1 addition & 1 deletion source/user/overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Overview

architecture
user-roles
cookiecutter
cookiecutter-template
develop-model
train-model-locally
try-model-locally
Expand Down

0 comments on commit b43992e

Please sign in to comment.