Skip to content
This repository was archived by the owner on Sep 22, 2023. It is now read-only.

Commit d88f302

Browse files
labluplablup
authored andcommitted
modified all review
1 parent eebe7f2 commit d88f302

File tree

4 files changed

+48
-38
lines changed

4 files changed

+48
-38
lines changed

docs/cli/code-execution.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ Compute sessions
99
Please consult the detailed usage in the help of each command.
1010
(use ``-h`` or ``--help`` argument to display the manual)
1111

12-
----------------
12+
1313
Listing sessions
14-
----------------
14+
~~~~~~~~~~~~~~~~
1515

1616
List the session owned by you with various status filters.
1717
The most recently status-changed sessions are listed first.
@@ -96,9 +96,9 @@ Both commands offer options to specify which fields of sessions should be printe
9696
9797
.. _simple-execution:
9898

99-
-----------------------
99+
100100
Running simple sessions
101-
-----------------------
101+
~~~~~~~~~~~~~~~~~~~~~~~
102102

103103
The following command spawns a Python session and executes
104104
the code passed as ``-c`` argument immediately.
@@ -148,9 +148,9 @@ To watch what is happening behind the scene until the session starts,
148148
try ``backend.ai events <sessionID>`` to receive the lifecycle events
149149
such as its scheduling and preparation steps.
150150

151-
----------------------------------
151+
152152
Running sessions with accelerators
153-
----------------------------------
153+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
154154

155155
Use one or more ``-r`` options to specify resource requirements when
156156
using ``backend.ai run`` and ``backend.ai start`` commands.
@@ -165,9 +165,9 @@ memory to execute ``./mygpucode.py`` file inside it.
165165
-r cpu=4 -r mem=8g -r cuda.shares=2 \
166166
python-tensorflow:1.12-py36 ./mygpucode.py
167167
168-
----------------------------------
168+
169169
Terminating or cancelling sessions
170-
----------------------------------
170+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
171171

172172
Without ``--rm`` option, your session remains alive for a configured
173173
amount of idle timeout (default is 30 minutes).
@@ -290,9 +290,9 @@ Container Applications
290290
Please consult the detailed usage in the help of each command
291291
(use ``-h`` or ``--help`` argument to display the manual).
292292

293-
---------------------------------------------------------
293+
294294
Starting a session and connecting to its Jupyter Notebook
295-
---------------------------------------------------------
295+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
296296

297297
The following command first spawns a Python session named "mysession"
298298
without running any code immediately, and then executes a local proxy which
@@ -315,9 +315,9 @@ For the jupyter service, use your favorite web browser just like the
315315
way you use Jupyter Notebooks.
316316
To stop the ``app`` command, press ``Ctrl+C`` or send the ``SIGINT`` signal.
317317

318-
-------------------------------------
318+
319319
Accessing sessions via a web terminal
320-
-------------------------------------
320+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321321

322322
All Backend.AI sessions expose an intrinsic application named ``"ttyd"``.
323323
It is an web application that embeds xterm.js-based full-screen terminal
@@ -359,9 +359,9 @@ Options for ``app`` commands
359359
* - ``-e, --env "ENVNAME=envvalue"``
360360
- Add additional environment variable when starting service.
361361

362-
--------------------------------------
362+
363363
Accessing sessions via native SSH/SFTP
364-
--------------------------------------
364+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
365365

366366
Backend.AI offers direct access to compute sessions (containers) via SSH
367367
and SFTP, by auto-generating host identity and user keypairs for all
@@ -520,9 +520,9 @@ Advanced Code Execution
520520
Please consult the detailed usage in the help of each command
521521
(use ``-h`` or ``--help`` argument to display the manual).
522522

523-
--------------------------------------
523+
524524
Running concurrent experiment sessions
525-
--------------------------------------
525+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
526526

527527
In addition to single-shot code execution as described in
528528
:ref:`simple-execution`, the ``run`` command offers concurrent execution of
@@ -588,9 +588,9 @@ values specified by each range.
588588
Session Templates
589589
-----------------
590590

591-
--------------------------------------
591+
592592
Creating and starting session template
593-
--------------------------------------
593+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
594594

595595
Users may define commonly used set of session creation parameters as
596596
reusable templates.
@@ -679,9 +679,10 @@ Other CRUD command examples are as follows:
679679

680680
* - ``update``
681681
- Update task template stored in Backend.AI Manager.
682-
-----------------------------
682+
683+
683684
Full syntax for task template
684-
-----------------------------
685+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
685686

686687
.. code-block:: text
687688

docs/cli/config.rst

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,13 +66,18 @@ Run the following command to list your current active configurations.
6666
6767
Command Reference
6868
-----------------------------------
69-
+-----------+----------------------------------------------------------------------+
70-
| Command | Description |
71-
+===========+======================================================================+
72-
| login | Log-in to the console API proxy. |
73-
+-----------+----------------------------------------------------------------------+
74-
| logout | Log-out from the console API proxy and clears the local cookie data. |
75-
+-----------+----------------------------------------------------------------------+
76-
| config | Shows the current configuration. |
77-
+-----------+----------------------------------------------------------------------+
69+
.. list-table::
70+
:widths: 15 85
71+
:header-rows: 1
7872

73+
* - Command
74+
- Description
75+
76+
* - ``login``
77+
- Log-in to the console API proxy..
78+
79+
* - ``logout``
80+
- Log-out from the console API proxy and clears the local cookie data.
81+
82+
* - ``config``
83+
- Shows the current configuration.

docs/cli/storage.rst

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,17 @@ between users and user group members.
1414
Vfolder Basics
1515
--------------
1616

17-
-----------------------------------
17+
1818
Creating vfolders and managing them
19-
-----------------------------------
19+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2020

2121
The command-line interface provides a set of subcommands under ``backend.ai
2222
vfolder`` to manage vfolders and files inside them.
2323

24+
.. code-block:: console
25+
26+
$ backend.ai vfolder [subcommands]
27+
2428
To list accessible vfolders including your own ones and those shared by
2529
other users:
2630

@@ -47,9 +51,9 @@ To delete the vfolder completey:
4751
4852
$ backend.ai vfolder delete mydata1
4953
50-
-----------------------------
54+
5155
File transfers and management
52-
-----------------------------
56+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5357

5458
To upload a file from the current working directory into the vfolder:
5559

@@ -80,9 +84,9 @@ To delete files in the vfolder:
8084
All file uploads and downloads overwrite existing files and all file
8185
operations are irreversible.
8286

83-
------------------------------
87+
8488
Running sessions with storages
85-
------------------------------
89+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8690

8791
The following command spawns a Python session where the virtual folder
8892
"mydata1" is mounted. The execution options are omitted in this example.
@@ -103,9 +107,9 @@ By reusing the same vfolder in subsequent sessions, you do not have to
103107
donwload the result and upload it as the input for next sessions, just
104108
keeping them in the storage.
105109

106-
----------------------------------
110+
107111
Creating default files for kernels
108-
----------------------------------
112+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109113

110114
Backend.AI has a feature called 'dotfile', created to all the kernels
111115
user spawns. As you can guess, dotfile's path should start with ``.``.

src/ai/backend/client/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
*session.__all__,
77
)
88

9-
__version__ = '21.03.0.dev0'
9+
__version__ = '20.09.0'
1010

1111

1212
def get_user_agent():

0 commit comments

Comments
 (0)