You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@datalab.apache.org by vv...@apache.org on 2022/06/16 13:51:07 UTC
[incubator-datalab] branch user_gide_image updated: Update USER_GUIDE.md
This is an automated email from the ASF dual-hosted git repository.
vvitanska pushed a commit to branch user_gide_image
in repository https://gitbox.apache.org/repos/asf/incubator-datalab.git
The following commit(s) were added to refs/heads/user_gide_image by this push:
new 2c7e5fb96 Update USER_GUIDE.md
2c7e5fb96 is described below
commit 2c7e5fb9628376f55fe5990b21a5310023ceac50
Author: viravit <vi...@epam.com>
AuthorDate: Thu Jun 16 15:51:03 2022 +0200
Update USER_GUIDE.md
---
USER_GUIDE.md | 51 +++++++++++++++++++++++++++++++++++++++------------
1 file changed, 39 insertions(+), 12 deletions(-)
diff --git a/USER_GUIDE.md b/USER_GUIDE.md
index 880a3df7f..f5765c775 100644
--- a/USER_GUIDE.md
+++ b/USER_GUIDE.md
@@ -82,7 +82,11 @@ DataLab Web Application authenticates users against:
\* Please refer to official documentation from Amazon to figure out how to manage Access Keys for your AWS Account: http://docs.aws.amazon.com/general/latest/gr/managing-aws-access-keys.html
-To stop working with DataLab - click on Log Out link at the top right corner of DataLab.
+To stop working with DataLab - click on user icon <img src="doc/user.png" alt="user" width="20"> at the top right corner of DataLab and hit "Log out from account" button:
+
+<p align="center" class="facebox-popup">
+ <img src="doc/user_information.png" alt="User information" width="300">
+</p>
After login user sees warning in case of exceeding quota or close to this limit.
@@ -107,9 +111,9 @@ To do this click on “Upload” button on “Projects” page, select your pers
Please note, that you need to have a key pair combination (public and private key) to work with DataLab. To figure out how to create public and private key, please click on “Where can I get public key?” on “Projects” page. DataLab build-in wiki page guides Windows, MasOS and Linux on how to generate SSH key pairs quickly.
-Creation of Project starts after hitting "Create" button. This process is a one-time operation for each Data Scientist and it might take up-to 10 minutes for DataLab to setup initial infrastructure for you. During this process project is in status "Creating".
+Creation of Project starts after hitting "Create" button. This process is a one-time operation for each Data Scientist and it might take up-to 25 minutes for DataLab to setup initial infrastructure for you. During this process project is in status "Creating".
-As soon as Project is created, Data Scientist can create notebook server on “Resources” page. The message “To start working, please create new environment” is appeared on “Resources” page:
+As soon as Project is created, Data Scientist can create notebook server in “Resources” section on "Instances" page . The message “To start working, please create new environment” is appeared on “Instances” page:
@@ -119,7 +123,7 @@ As soon as Project is created, Data Scientist can create notebook server on “
## Create notebook server <a name="notebook_create"></a>
-To create new analytical environment from “Resources” page click on "Create new" button.
+To create new analytical environment from “Instances” page click on "Create new" button.
The "Create analytical tool" popup shows up. Data Scientist can choose the preferred project, endpoint and analytical tool. Adding new analytical toolset is supported by architecture, so you can expect new templates to show up in upcoming releases.
Currently by means of DataLab, Data Scientists can select between any of the following templates:
@@ -139,7 +143,7 @@ Currently by means of DataLab, Data Scientists can select between any of the fol
After specifying desired template, you should fill in the “Name” and “Instance shape”.
-Keep in mind that "Name" field – is just for visual differentiation between analytical tools on “resources” dashboard.
+Keep in mind that "Name" field – is just for visual differentiation between analytical tools on “Instances” dashboard.
Instance shape dropdown, contains configurable list of shapes, which should be chosen depending on the type of analytical work to be performed. Following groups of instance shapes are showing up with default setup configuration:
@@ -199,7 +203,7 @@ On every analytical tool instance you can install additional libraries by clicki
After clicking you see the window with 4 fields:
- Field for selecting an active resource to install libraries
-- Field for selecting group of packages (apt/yum, Python 2, Python 3, R, Java, Others)
+- Field for selecting group of packages (apt/yum, Python 3, R, Java, Others)
- Field for search available packages with autocomplete feature (if it's gained) except Java dependencies. For Java library you should enter using the next format: "groupID:artifactID:versionID"
- Field for library version. It's an optional field.
@@ -211,7 +215,7 @@ You need to wait for a while after resource and group choosing till list of all
**Note:** Apt or Yum packages depend on your DataLab OS family.
-**Note:** In group Others you can find other Python (2/3) packages, which haven't classifiers of version.
+**Note:** In group Others you can find other Python (3) packages, which haven't classifiers of version.
After selecting library, you can see it in the midle of the window and can delete it from this list before installation.
@@ -251,6 +255,18 @@ To create new analytical environment from custom image click on "Create new" but
Before clicking "Create" button you should choose the image from "Select AMI" and fill in the "Name" and "Instance shape". For Deeplearning notebook on GCP there is also a list of predefined images.
+In addition, you can view the list of all images which are created by you and shared with you on the "Images" page:
+
+
+
+You can share the image in Created status with all users in the project or terminate it if you are image creator/owner. Creator is the user who has created the image.
+Owner is the user who is owning the right to manage image and perform Share and Terminate actions. The owners are Creator and Admin.
+To share or terminate image click on a gear icon <img src="doc/gear_icon.png" alt="gear" width="20"> in the "Actions" menu for a needed image and hit "Terminate" or "Share" button appropriately.
+
+<p align="center">
+ <img src="doc/image_action_menu.png" alt="Image action menu" width="150">
+</p>
+
--------------------------
## Stop Notebook server <a name="notebook_stop"></a>
@@ -364,7 +380,7 @@ To do that open any of the analytical tools and select proper kernel/interpreter
**Jupyter** – go to Kernel and choose preferable interpreter between local and Computational resource ones. Currently we have added support of Python 3, Spark, Scala, R in Jupyter.
-
+
As you know, you can install library thanks to [Manage libraries functionality](#manage_libraries), but in addition you are supposed to install library via Jupyter cell using the next command (i.e., for Python group):
@@ -379,7 +395,6 @@ As you know, you can install library thanks to [Manage libraries functionality](
Insert following “magics” before blocks of your code to start executing your analytical jobs:
- interpreter\_name.%spark – for Scala and Spark;
-- interpreter\_name.%pyspark – for Python2;
- interpreter\_name.%pyspark3 – for Python3;
- interpreter\_name.%sparkr – for R;
@@ -540,8 +555,8 @@ Also clicking on "Circle" button you can uncommit or revert changes.
You are able to access to cloud buckets via DataLab Web UI.
There are two ways to open bucket browser:
-- clicking on Notebook name on the "List of resources" page, where there is an "Open bucket browser" link;
-- clicking on "Bucket browser" bucket on the "List of resources" page.
+- clicking on Notebook name on the "Instances" page, where there is an "Open bucket browser" link;
+- clicking on "Bucket browser" bucket on the "Instances" page.
@@ -563,6 +578,18 @@ In the bucket browser you are supposed to:
--------------------------------
# Administration <a name="administration"></a>
+There are four pages in the "Administration" panel:
+
+<p align="center">
+ <img src="doc/administration_section.png" alt="Administration section" width="150">
+</p>
+
+- "Users" page, where administrator can assign appropriate permisions for users;
+- "Projects" page, where administrator can manage a project;
+- "Resources" page, where administrator monitor and manage project resources;
+- "Configuration" page, where administrator can view and change configuration files and restart DataLab services.
+
+
## Manage roles <a name="manage_roles"></a>
Administrator can choose what instance shape(s), notebook(s) and computational resource are supposed to create for certain group(s) or user(s). Administrator can also assign administrator per project, who is able to manage roles within particular project.
@@ -750,7 +777,7 @@ You are able to view:
- who did the action
- what the action was done
-Furthermore on the center of header you can choose period of report in datepicker.
+Furthermore, on the center of header you can choose period of report in datepicker.
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@datalab.apache.org
For additional commands, e-mail: commits-help@datalab.apache.org