Driverless AI
-------------

The Driverless AI Instances page shows all created Driverless AI instances that are in the environment. Note that this page is only available after the Kubernetes backend is enabled by the Admin. 

.. figure:: images/dai_instance_blank.png
	:alt: Diverless AI Instance page

Adding a Driverless AI Instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

1. Click the **Launch Instance** button.

2. Select the profile to associate with this instance. (Note that this list is maintained by the Admin.) If the profile includes configuration overrides, then that information will be included in the Configuration section.

3. Specify values for the options below: 

 - **Instance Name**: Specify a unique name for the Driverless AI instance.
 - **Version**: Select the Driverless AI version.
 - **Number of CPUS**: Specify the number of CPUs.
 - **Number of GPUS**: Specify the number of GPUs.
 - **Memory [GB]**: Specify the amount of memory.
 - **Storage [GB]**: Specify the amount of storage.
 - **Timeout [S]**: Specify the number of seconds to wait for the Driverless AI instance instance to come up.

4. Click **Launch Instance** to create the instance.

.. figure:: images/launch_instance.png
	:alt: Launch DAI Instance

After the Driverless AI Instance is launched, to access Driverless AI click the **Instance Name**. This will open up your Driverless AI instance onto the Datasets page.

**Note**: You can only access the Driverless AI instance if created by the Admin.

Upgrading a Driverless AI Instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can upgrade an instance to a newer version of Driverless AI. 

**Note**: The instance must be in a "Stopped" state before you can upgrade. You can update the admin instance and other user instances. 

.. figure:: images/dai_upgrade.png
	:alt: Upgrade DAI Instance
	:scale: 40%

Before you upgrade your instance, a prompt will appear allowing you to select the Driverless AI version to upgrade to. Click the **Upgrade** button to upgrade the instance.

.. figure:: images/dai_upgrade_prompt.png
	:alt: DAI Upgrade Prompt
	:scale: 40%

Driverless AI Details
~~~~~~~~~~~~~~~~~~~~~

To view the details of a "Running" or "Stopped" instance, click the **Actions > Detail** option.

.. figure:: images/dai_detail.png
	:alt: Details DAI
	:scale: 40%

Driverless AI Log
~~~~~~~~~~~~~~~~~

You can download a plain text log for your "Running" Driverless AI instance directly from the UI. Click the **Actions > Logs** option and then click the **Download** button to download your log.

**Note**: Logs are only available for a running Driverless AI instance.

.. figure:: images/dai_logs.png
	:alt: DAI Logs
	:scale: 40%

Driverless AI Events
~~~~~~~~~~~~~~~~~~~~

To view the events of a "Running" or "Stopped" instance, click the **Actions > Events** option.

.. figure:: images/dai_events.png
	:alt: DAI Events
	:scale: 40% 

Stopping a Driverless AI Instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can stop a "Running" Driverless AI instance by clicking on **Actions > Stop** beside the instance that you want to stop. You can stop both Admin-created and user-created instances.

.. figure:: images/dai_stop.png
   :alt: Stop Driverless AI instance
   :scale: 40%

Starting a Driverless AI Instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To start a "Stopped" Driverless AI instance, click the **Actions > Start** option. On the restart instance page, click **Start Instance** to restart the instance.

**Note**: When restarting a Driverless AI instance, you cannot change the Name, Version, or Storage of the instance. You can restart both Admin-created and user-created instances.

.. figure:: images/start_dai.png
	:alt: Restart a DAI Instance
	:scale: 40%

Terminating a Driverless AI Instance
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

You can terminate a "Stopped" Driverless AI instance by clicking the **Actions > Terminate** option. A prompt for terminating the server will appear warning you that terminating the instance will cause you to lose all experiments on that instance. To terminate the server, click the **Yes, Stop** button. You can terminate both Admin-created and user-created instances.

.. figure:: images/terminate_dai.png
	:alt: Terminate DAI
	:scale: 40%