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 17, 2023
1 parent 4806d28 commit 5eb5d06
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 8 deletions.
6 changes: 5 additions & 1 deletion source/user/howto/rclone.rst
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,11 @@ Once you machine is launched, you must run the following command in the terminal

.. code-block:: console
$ export RCLONE_CONFIG_RSHARE_PASS=$(rclone obscure $RCLONE_CONFIG_RSHARE_PASS)
$ echo export RCLONE_CONFIG_RSHARE_PASS=$(rclone obscure $RCLONE_CONFIG_RSHARE_PASS) >> /root/.bashrc
$ source /root/.bashrc
..
Comment: We do this to spare users from having to install rclone in their local machines just to obscure the password.
This is because, to connect with the remote, rclone needs to use an obscured version of the password, not the raw one.

Expand Down
8 changes: 5 additions & 3 deletions source/user/howto/train-model-locally.rst
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ In your local machine, run the Template with the ``child-module`` branch.
.. code-block::
$ pip install cookiecutter
$ cookiecutter https://github.com/deephdc/cookiecutter-deep -b child-module
$ cookiecutter https://github.com/deephdc/cookiecutter-deep --checkout child-module
This will create a single repo (``DEEP-OC-**``) with the Docker code.

Expand All @@ -169,7 +169,9 @@ Check you didn't mess up the JSON formatting by running:
is the image of the original repo. Modify the appropriate lines to replace
the original model weights with the new model weights.
In our case, this could look something like this:
::

.. code-block:: docker
ENV SWIFT_CONTAINER https://api.cloud.ifca.es:8080/swift/v1/phytoplankton-tf/
ENV MODEL_TAR phytoplankton.tar.xz
Expand All @@ -179,7 +181,7 @@ In our case, this could look something like this:
Check your Dockerfile works correctly by building it locally and running it:

.. code-block:: console
.. code-block:: console
$ docker build --no-cache -t your_project .
$ docker run -ti -p 5000:5000 -p 6006:6006 -p 8888:8888 your_project
Expand Down
5 changes: 3 additions & 2 deletions source/user/howto/train-model-remotely.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ See the :doc:`Dashboard guide <../overview/dashboard>` for more details.
After submitting you will be redirected to the deployment's list.
In your new deployment go to **Access** and choose **JupyterLab**. You will be redirected to ``http://jupyterlab_endpoint``

Now that you are in JupyterLab, open a **Terminal** window (**[+]** (New launcher) ➜ **Others** ➜ **Terminal**).
Now that you are in JupyterLab, open a **Terminal** window (:fa:`square-plus` (New launcher) ➜ **Others** ➜ **Terminal**).

First let's check we are seeing our GPU correctly:

Expand Down Expand Up @@ -172,6 +172,7 @@ For this you have to kill the process running deepaas, and launch it again.
.. code-block:: console
$ kill -9 $(ps aux | grep '[d]eepaas-run' | awk '{print $2}')
$ kill -9 $(ps aux | grep '[t]ensorboard' | awk '{print $2}') # optionally also kill monitoring process
This is because the user inputs for deepaas are generated at the deepaas launching.
Thus it is not aware of the newly trained model. Once deepaas is restarted, head to the
Expand Down Expand Up @@ -215,7 +216,7 @@ In your **local machine** (not the Dashboard deployment), run the Template with
.. code-block::
$ pip install cookiecutter
$ cookiecutter https://github.com/deephdc/cookiecutter-deep -b child-module
$ cookiecutter https://github.com/deephdc/cookiecutter-deep --checkout child-module
Proceed to answer the questions you will be prompted.
This will create a single repo (``DEEP-OC-**``) with the Docker code.
Expand Down
2 changes: 1 addition & 1 deletion source/user/overview/cookiecutter-template.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ and then run the `cookiecutter <https://cookiecutter.readthedocs.io>`__ tool as
::

$ pip install cookiecutter
$ cookiecutter https://github.com/deephdc/cookiecutter-deep -b master
$ cookiecutter https://github.com/deephdc/cookiecutter-deep --checkout master

You are first provided with ``[Info]`` line about the parameter and in the next line you configure this parameter.
You will be asked to configure:
Expand Down
2 changes: 1 addition & 1 deletion source/user/overview/dashboard.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ The are two steps in the configuration process:
reflected in DEEPaaS (which is launched with the initial codebase), thus potentially leading to confusion.

If you want to have access to both services in the same deployment, launch with JupyterLab.
In JupyterLab, open a **Terminal** window (**[+]** (New launcher) ➜ **Others** ➜ **Terminal**).
In JupyterLab, open a **Terminal** window (:fa:`square-plus` (New launcher) ➜ **Others** ➜ **Terminal**).
Then run ``deep-start --deepaas`` to launch DEEPaaS.
If you make subsequent code changes, you will have to kill the old DEEPaaS process and launch a new one.

Expand Down

0 comments on commit 5eb5d06

Please sign in to comment.