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

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IgnacioHeredia committed Jan 19, 2023
1 parent d907d69 commit ba9cda8
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
14 changes: 7 additions & 7 deletions source/user/howto/develop-model.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. highlight:: console

Develop a model
===============
Develop a model from scratch
============================

This tutorial explains how to develop a DEEP module from scratch on your local machine.

Expand Down Expand Up @@ -42,7 +42,7 @@ Go to Github and create the corresponding repositories:
Do a ``git push origin --all`` in both created directories to put your initial code in Github.


2. Editing ``<your_project>`` code
2. Editing ``<project-name>`` code
----------------------------------

Install your project as a Python module in **editable** mode (so that the changes you make to the codebase are picked by Python).
Expand Down Expand Up @@ -113,10 +113,10 @@ in some parts of the code if long lines are really needed.
Remember to have a backup before reformatting, just in case!

Once you are fine with the state of ``<your_project>`` folder, push the changes to Github.
Once you are fine with the state of ``<project-name>`` folder, push the changes to Github.


3. Editing ``DEEP-OC-<your_project>`` code
3. Editing ``DEEP-OC-<project-name>`` code
------------------------------------------

This is the repo in charge of creating a single docker image that integrates
Expand All @@ -134,7 +134,7 @@ You need to modify the following files according to your needs:
$ docker run -ti -p 5000:5000 -p 6006:6006 -p 8888:8888 your_project #
Your module should be visible in http://0.0.0.0:5000/ui .
You can make a POST request to the ``predict``method to check everything is working as intended.
You can make a POST request to the ``predict`` method to check everything is working as intended.

* ``metadata.json``: this is the information that will be displayed in the Marketplace.
Update and add the information you need.
Expand All @@ -145,7 +145,7 @@ You can make a POST request to the ``predict``method to check everything is work
$ pip install git+https://github.com/deephdc/schema4apps
$ deep-app-schema-validator metadata.json
Once you are fine with the state of ``DEEP-OC-<your_project>``, push the changes to Github.
Once you are fine with the state of ``DEEP-OC-<project-name>``, push the changes to Github.


4. Integrating the module in the Marketplace
Expand Down
11 changes: 8 additions & 3 deletions source/user/modules/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,15 @@ All modules are found at the `DEEP Marketplace <https://marketplace.deep-hybrid
hosted under `Github's deephdc <https://github.com/deephdc>`__ organization and the corresponding Docker images are
hosted under `DockerHub's deephdc <https://hub.docker.com/u/deephdc/>`__ organization.

Github repositories follow the following convention:
Modules developed by **deephdc members** follow the following convention:

* ``deephdc/some_module``: source code of the module
* ``deephdc/DEEP-OC-some_module``: Dockerfiles and metadata of that module.
* ``deephdc/<project-name>``: source code of the module
* ``deephdc/DEEP-OC-<project-name>``: Dockerfiles and metadata of that module.

Modules developed by **external users** follow the following convention:

* ``deephdc/UC-<github-user>-<project-name>``: source code of the module
* ``deephdc/UC-<github-user>-DEEP-OC-<project-name>``: Dockerfiles and metadata of that module.

Docker images have usually tags depending on whether they are using Github's ``master`` or ``test`` and
whether they use ``cpu`` or ``gpu``. Tags are usually:
Expand Down

0 comments on commit ba9cda8

Please sign in to comment.