Backend.AI Web-UI User Guide

User’s guide for the Backend.AI Web-UI.

Backend.AI Web-UI is a web or app that provides easy-to-use GUI interface to work with the Backend.AI server.

The latest versions of this document can be found from sites below:

• https://webui.docs.backend.ai/en/stable (English)

• https://webui.docs.backend.ai/ko/stable (Korean)

Table of Contents

• Quickstart
  • Objectives
• Disclaimer
• Overview
  • Key Concepts
  • Backend.AI feature details
  • Accessible menu by user role
• Installation
• Signup and Login
  • Signup
  • Login
  • When you forgot your password
  • Sidebar Menus
• Summary Page
  • Topbar
  • Summary panel
• Compute Sessions
  • Start a new session
  • Use Jupyter Notebook
  • Use web terminal
  • Query compute session log
  • Rename running session
  • Delete a compute session
  • Idleness Checks
  • How to add environment variable before creating a session
  • How to add preopen ports before creating a session
  • Save container commit
  • Optimizing Accelerated Computing
  • Advanced web terminal usage
• Model Serving
  • Model Service
  • Configuring and limitations of model service in version 23.03 and earlier
  • Guide to Steps for Using Model Service
• Import & Run notebooks and web based Git repositories
  • Import and run Jupyter notebooks
  • Create executable Jupyter notebook button
  • Importing GitHub Repositories
  • Importing GitLab Repositories
• Handling Data & Storage Folders
  • Create storage folder
  • Explore folder
  • Rename folder
  • Delete folder
  • Automount folder
  • Using FileBrowser
  • Using SFTP Server
• Mounting Folders to a Compute Session
  • Configure a compute session environment using an automount folder
• Sharing Storage Folders and Access Control
  • Share storage folders with other users
  • Adjust permission for shared folders
• Agent Summary
• Statistics Page
• SSH/SFTP Connection to a Compute Session
  • For Linux / Mac
  • For Windows / FileZilla
  • For Visual Studio Code
  • Establish SSH connection with Backend.AI client package
• User Settings
  • GENERAL tab
  • LOGS tab
• Backend.AI Cluster Compute Session
  • Overview of Backend.AI cluster compute session
  • Use of Backend.AI cluster compute session
• Admin Menus
  • Create and update users
  • Inactivate user account
  • Manage User’s Keypairs
  • Share project storage folders with project members
  • Manage Resource Policy
  • Manage Images
  • Manager docker registry
  • Manage resource preset
  • Manage agent nodes
  • Manage resource group
  • Storages
  • Download session lists
  • System settings
  • Server management
  • Detailed Information
• FAQs & Troubleshooting
  • User troubleshooting guide
  • Admin troubleshooting guide
• Appendix
  • GPU virtualization and fractional GPU allocation
  • Automated job scheduling
  • Multi-version machine learning container support
  • Convert a compute session to a new private Docker image
  • Backend.AI Server Installation Guide
  • Backend.AI Server Management Guide
• Terms of License Agreement
  • Backend.AI License (Software)
• References