Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
45 changes: 22 additions & 23 deletions packages/backend.ai-webui-docs/src/en/import_run/import_run.md
Original file line number Diff line number Diff line change
@@ -1,47 +1,46 @@
# Import & Run notebooks and web based Git repositories
# Import & Run Notebooks and Web-Based Git Repositories


On the 'Import & Run' page, Backend.AI supports executing Jupyter notebook files and importing web based Git repositories
On the Import & Run page, Backend.AI supports executing Jupyter notebook files and importing web-based Git repositories
such as GitHub and GitLab on the fly. You don't need to create or download into your local storage
and re-upload it. The only thing you have to do is input a valid URL you want to execute or import,
and click the button on the right side.

<a id="import-and-run-jupyter-notebooks"></a>

## Import and run Jupyter notebooks
## Import and Run Jupyter Notebooks

To import Jupyter notebooks and run, you need one thing, the valid URL for the notebook file.
For example, if you want execute Jupyter notebook that's in github, you can copy and paste
the URL and click the 'Import & Run' button.
To import and run Jupyter notebooks, you need the valid URL for the notebook file.
For example, if you want to execute a Jupyter notebook on GitHub, you can copy and paste
the URL and click the `Import & Run` button.

:::note
When you try to import and run a Jupyter notebook file with a local address,
it will be regarded as invalid. You have to input a URL that does not start with localhost.
it will be regarded as invalid. You must input a URL that does not start with `localhost`.
:::

![](../images/import_run_notebook.png)

After clicking the button, the dialog appears. This is a session launcher dialog same as
when you starts the session at Sessions page or Summary page. Difference between import notebook
and starting a new session is that import notebook automatically imports Jupyter notebook in the
URL, but simple starting a new session doesn't do that. the rest is same. Click 'LAUNCH' button to
the notebook after setting the environments and resource allocation as needed.
After clicking the button, a dialog appears. This is the same session launcher dialog that appears
when you start a session from the Sessions page or Summary page. The difference between importing a notebook
and starting a new session is that importing a notebook automatically imports the Jupyter notebook from the
URL. The rest is the same. Set the environment and resource allocation as needed, then click the `Launch` button.

:::note
The pop-up blocker must be turned off before clicking 'LAUNCH' button to immediately
see the running notebook window. Also, if there's not enough resources to execute the session,
imported Jupyter notebook will not run.
The pop-up blocker must be turned off before clicking the `Launch` button to immediately
see the running notebook window. Also, if there are not enough resources to execute the session,
the imported Jupyter notebook will not run.
:::

![](../images/session_launcher_in_importing_notebook.png)

You can see the importing operation is successfully completed in Sessions page.
You can see the importing operation is successfully completed on the Sessions page.

![](../images/sessions_page_with_imported_notebook.png)

<a id="create-executable-jupyter-notebook-button"></a>

## Create executable Jupyter notebook button
## Create Executable Jupyter Notebook Button

You can also create an HTML or Markdown badge for a Jupyter notebook URL.
Input a valid Jupyter notebook URL and click the `Notebook Badge Code (HTML)` or
Expand All @@ -59,15 +58,15 @@ Your account must be logged in before clicking the button. Otherwise, you have t

## Importing GitHub Repositories

Importing a GitHub repository is similar to import and running Jupyter notebook.
Importing a GitHub repository is similar to importing and running a Jupyter notebook.
All you have to do is fill in the GitHub repository URL, select a storage host from the
`Storage Host` dropdown, and click the `Get To Folder` button.

![](../images/import_github_repository.png)

:::note
If there are not enough resources to start a session or folder count is at
the limit, then importing repository will fail. Please check resource
If there are not enough resources to start a session or the folder count is at
the limit, then importing the repository will fail. Please check the resource
statistics panel and Data & Storage page before importing the repository.
:::

Expand All @@ -87,6 +86,6 @@ but you need to explicitly set the branch name to import.
![](../images/import_gitlab_repository.png)

:::note
If there's a storage folder that has the same name already, the system will append
`_` (underscore) and number in the imported repository folder.
:::
If there is a storage folder that has the same name already, the system will append
`_` (underscore) and a number to the imported repository folder name.
:::
20 changes: 14 additions & 6 deletions packages/backend.ai-webui-docs/src/en/start/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ external URLs.
## Announcement Banner

If your system administrator has published an announcement, it appears as a
banner at the top of the Start page. You can dismiss the banner by clicking the
close icon. The announcement supports Markdown formatting and may contain
important notices about system maintenance, updates, or usage guidelines.
banner at the top of the Start page. The announcement supports Markdown
formatting and may contain important notices about system maintenance, updates,
or usage guidelines. You can dismiss the banner by clicking the close icon.

![](../images/start_announcement_banner.png)

## Action Cards

Expand All @@ -21,8 +23,8 @@ The Start page displays the following action cards by default:
- **Create New Storage Folder**: Create a storage folder and upload files. This
is an essential first step for training models or providing external services.
Clicking the button opens the folder creation dialog.
- **Start Interactive Session**: Create an interactive session to train a model.
Choose your preferred environment and resources to run your code.
- **Start Interactive Session**: Create a session to train a model. Choose your
preferred environment and resources to run your code.
- **Start Batch Session**: Create a batch session for predefined files or
scheduled tasks. Enter the command, set the date and time, and run the session
on demand.
Expand All @@ -40,10 +42,12 @@ system administrator.
## Start From URL

The **Start From URL** card allows you to import and run projects directly from
external sources. Clicking the card opens a dialog with three tabs:
external sources. Clicking the card opens a dialog with three tabs.

### Import Notebook

![](../images/start_from_url_notebook.png)

1. Enter a Jupyter Notebook URL (must end with `.ipynb`) in the **Notebook URL**
field
2. Click **Import & Run** to automatically create a session and open the
Expand All @@ -58,6 +62,8 @@ project documentation.

### Import GitHub Repository

![](../images/start_from_url_github.png)

1. Enter a valid GitHub repository URL in the **GitHub URL** field
2. Select a **Storage Host** where the repository will be saved
3. Optionally set the **Folder Usage Mode** (General or Models)
Expand All @@ -68,6 +74,8 @@ when starting a session.

### Import GitLab Repository

![](../images/start_from_url_gitlab.png)

1. Enter a valid GitLab repository URL in the **GitLab URL** field
2. Optionally specify a **GitLab Branch Name** (defaults to `master`)
3. Select a **Storage Host** where the repository will be saved
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Jupyterノートブックをインポートして実行するには、ノート

![](../images/import_run_notebook.png)

ボタンをクリックすると、ダイアログが表示されます。これはセッションページやサマリーページからセッションを開始する場合と同じセッションランチャーダイアログです。ノートブックのインポートと新しいセッションの開始の違いは、ノートブックのインポートではURLにあるJupyterノートブックが自動的にインポートされることです。残りは同じです。必要に応じて環境とリソース配分を設定した後、「Launch」ボタンをクリックします。
ボタンをクリックすると、ダイアログが表示されます。これはセッションページやサマリーページからセッションを開始する場合と同じセッションランチャーダイアログです。ノートブックのインポートと新しいセッションの開始の違いは、ノートブックのインポートではURLにあるJupyterノートブックが自動的にインポートされることです。残りは同じです。必要に応じて環境とリソース配分を設定した後、「ローンチ」ボタンをクリックします。

:::note
Launch」ボタンをクリックする前に、ポップアップブロッカーをオフにする必要があります。そうしないと、実行中のノートブックウィンドウがすぐに表示されません。また、セッションを実行するためのリソースが不足している場合、インポートされたJupyterノートブックは実行されません。
ローンチ」ボタンをクリックする前に、ポップアップブロッカーをオフにする必要があります。そうしないと、実行中のノートブックウィンドウがすぐに表示されません。また、セッションを実行するためのリソースが不足している場合、インポートされたJupyterノートブックは実行されません。
:::

![](../images/session_launcher_in_importing_notebook.png)
Expand Down Expand Up @@ -76,4 +76,4 @@ GitHubリポジトリのURLを入力し、「ストレージホスト」ドロ

:::note
同じ名前のストレージフォルダがすでに存在する場合、システムはインポートされたリポジトリフォルダ名に`_`(アンダースコア)と番号を追加します。
:::
:::
44 changes: 27 additions & 17 deletions packages/backend.ai-webui-docs/src/ja/start/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,23 +10,25 @@
## お知らせバナー

システム管理者がお知らせを公開している場合、スタートページの上部にバナーが
表示されます。閉じるアイコンをクリックしてバナーを閉じることができます。
お知らせはMarkdown形式をサポートしており、システムメンテナンス、アップデート、
利用ガイドラインなどの重要な通知が含まれる場合があります。
表示されます。お知らせはMarkdown形式をサポートしており、システムメンテナンス、
アップデート、利用ガイドラインなどの重要な通知が含まれる場合があります。
閉じるアイコンをクリックしてバナーを閉じることができます。

![](../images/start_announcement_banner.png)

## アクションカード

スタートページにはデフォルトで以下のアクションカードが表示されます:

- **新しいストレージフォルダを作成**: ストレージフォルダを作成してファイルを
アップロードします。モデルの学習や外部サービス提供の準備に必要な最初の
ステップです。ボタンをクリックするとフォルダ作成ダイアログが開きます。
- **インタラクティブセッション開始**: モデル学習のためのインタラクティブセッションを
作成します。必要な環境とリソースを選択してコードを実行できます。
- **保存フォルダー作成**: ストレージフォルダを作成してファイルをアップロード
します。モデルの学習や外部サービス提供の準備に必要な最初のステップです。
ボタンをクリックするとフォルダ作成ダイアログが開きます。
- **インタラクティブセッション開始**: モデル学習のためのセッションを作成します。
必要な環境とリソースを選択してコードを実行できます。
- **バッチセッション開始**: 準備済みのファイルやスケジュールされたタスクのための
バッチセッションを作成します。コマンドを入力し、日時を設定して実行します。
- **モデルサービス開始**: 学習済みモデルを他のユーザーと共有するためのモデルサービス
エンドポイントを作成します
- **モデルサービス開始**: 学習済みモデルを他のユーザーと共有するためのモデル
サービスエンドポイントを作成します
- **URLから開始**: GitHub、GitLab、Jupyter NotebookなどのさまざまなURL環境から
プロジェクトとコードをインポートします。

Expand All @@ -43,6 +45,8 @@

### ノートブック取り込み

![](../images/start_from_url_notebook.png)

1. **ノートブックのURL**フィールドにJupyter Notebook URL(`.ipynb`で終わる)を
入力します
2. **インポート & 実行**をクリックすると、自動的にセッションが作成され、Jupyterで
Expand All @@ -57,21 +61,27 @@ Markdownのバッジコードをコピーして、プロジェクトのドキュ

### GitHubリポジトリをインポートする

1. **GitHub URL**フィールドに有効なGitHubリポジトリURLを入力します
![](../images/start_from_url_github.png)

1. **GitHubのURL**フィールドに有効なGitHubリポジトリURLを入力します
2. リポジトリを保存する**ストレージホスト**を選択します
3. 必要に応じて**フォルダ使用モード**(一般またはモデル)を設定します
4. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローンします
3. 必要に応じて**フォルダ利用モード**(一般またはモデル)を設定します
4. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローン
します

インポートされたリポジトリはストレージフォルダに変換され、セッション開始時に
マウントできます。

### GitLabリポジトリ取り込み

1. **GitLab URL**フィールドに有効なGitLabリポジトリURLを入力します
2. 必要に応じて**GitLabブランチ名**を指定します(デフォルト: `master`)
![](../images/start_from_url_gitlab.png)

1. **GitLabアドレス**フィールドに有効なGitLabリポジトリURLを入力します
2. 必要に応じて**GitLab ブランチ名**を指定します(デフォルト: `master`)
3. リポジトリを保存する**ストレージホスト**を選択します
4. 必要に応じて**フォルダ使用モード**(一般またはモデル)を設定します
5. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローンします
4. 必要に応じて**フォルダ利用モード**(一般またはモデル)を設定します
5. **フォルダに移動**をクリックしてリポジトリを新しいストレージフォルダにクローン
します

## カードレイアウトのカスタマイズ

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
37 changes: 22 additions & 15 deletions packages/backend.ai-webui-docs/src/ko/start/start.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,39 +9,42 @@
## 공지사항 배너

시스템 관리자가 공지사항을 게시한 경우, 시작 페이지 상단에 배너가 표시됩니다.
닫기 아이콘을 클릭하여 배너를 닫을 수 있습니다. 공지사항은 Markdown 형식을
지원하며, 시스템 유지보수, 업데이트, 사용 가이드라인 등 중요한 안내를 포함할 수
있습니다.
공지사항은 Markdown 형식을 지원하며, 시스템 유지보수, 업데이트, 사용 가이드라인 등
중요한 안내를 포함할 수 있습니다. 닫기 아이콘을 클릭하여 배너를 닫을 수 있습니다.

![](../images/start_announcement_banner.png)

## 액션 카드

시작 페이지에는 기본적으로 다음 액션 카드가 표시됩니다:

- **새 스토리지 폴더 생성**: 스토리지 폴더를 생성하고 파일을 업로드합니다. 모델을
학습시키거나 외부 서비스를 제공하기 위한 필수적인 첫 단계입니다. 버튼을 클릭하면
폴더 생성 대화상자가 열립니다.
- **Interactive 세션 생성**: 모델을 학습시킬 대화형 세션을 생성합니다. 원하는
환경과 리소스를 선택하여 코드를 실행할 수 있습니다.
- **새 스토리지 폴더 생성하기**: 스토리지 폴더를 생성하고 파일을 업로드합니다.
모델을 학습시키거나 외부 서비스를 제공하기 위한 필수적인 첫 단계입니다. 버튼을
클릭하면 폴더 생성 대화상자가 열립니다.
- **Interactive 세션 생성**: 모델을 학습시킬 세션을 생성합니다. 원하는 환경과
리소스를 선택하여 코드를 실행할 수 있습니다.
- **Batch 세션 생성**: 미리 정의된 파일 또는 예약된 작업을 위한 배치 세션을
생성합니다. 명령을 입력하고 날짜와 시간을 설정한 다음 필요에 따라 세션을
실행합니다.
- **모델 서비스 시작**: 학습이 끝난 모델을 다른 사람과 공유하기 위해 모델 서비스
엔드포인트를 생성합니다.
- **URL로 시작**: GitHub, GitLab, Jupyter Notebook 등 다양한 환경에서 URL을 통해
- **URL 로 시작**: GitHub, GitLab, Jupyter Notebook 등 다양한 환경에서 URL을 통해
프로젝트와 코드를 가져올 수 있습니다.

:::note
서버 설치 및 설정 환경에 따라, 모델 서비스 카드 등 일부 카드가 비활성화되어 있을
수 있습니다. 해당 기능의 사용을 원하시는 경우, 시스템 관리자에게 문의하십시오.
:::

## URL로 시작
## URL 로 시작

**URL로 시작** 카드를 사용하면 외부 소스에서 프로젝트를 가져와 바로 실행할 수
**URL 로 시작** 카드를 사용하면 외부 소스에서 프로젝트를 가져와 바로 실행할 수
있습니다. 카드를 클릭하면 세 개의 탭이 있는 대화상자가 열립니다.

### 노트북 가져오기

![](../images/start_from_url_notebook.png)

1. **가져올 노트북 URL** 필드에 Jupyter Notebook URL(`.ipynb`으로 끝나는)을
입력합니다
2. **가져와서 실행** 버튼을 클릭하면 자동으로 세션이 생성되고 Jupyter에서
Expand All @@ -56,19 +59,23 @@ Markdown 뱃지 코드를 복사하여 프로젝트 문서에 바로 실행 링

### GitHub 저장소 가져오기

1. **GitHub URL** 필드에 유효한 GitHub 저장소 URL을 입력합니다
![](../images/start_from_url_github.png)

1. **GitHub 주소** 필드에 유효한 GitHub 저장소 URL을 입력합니다
2. 저장소가 저장될 **스토리지 호스트**를 선택합니다
3. 필요한 경우 **폴더 사용 모드**(일반 또는 모델) 설정합니다
3. 필요한 경우 **폴더 사용 방식**(일반 또는 모델) 설정합니다
4. **가져오기** 버튼을 클릭하여 저장소를 새 스토리지 폴더로 복제합니다

가져온 저장소는 스토리지 폴더로 변환되며, 세션 시작 시 마운트할 수 있습니다.

### GitLab 저장소 가져오기

1. **GitLab URL** 필드에 유효한 GitLab 저장소 URL을 입력합니다
![](../images/start_from_url_gitlab.png)

1. **GitLab 주소** 필드에 유효한 GitLab 저장소 URL을 입력합니다
2. 필요한 경우 **GitLab 브랜치 이름**을 지정합니다 (기본값: `master`)
3. 저장소가 저장될 **스토리지 호스트**를 선택합니다
4. 필요한 경우 **폴더 사용 모드**(일반 또는 모델) 설정합니다
4. 필요한 경우 **폴더 사용 방식**(일반 또는 모델) 설정합니다
5. **가져오기** 버튼을 클릭하여 저장소를 새 스토리지 폴더로 복제합니다

## 카드 레이아웃 커스터마이즈
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Loading