.. _using_the_app:

#############
Using the app
#############

The app allows you to

* label data (upload videos, extract frames, annotate keypoints)
* train and evaluate models
* run inference on new videos

Additionally, the app comes with an example dataset if you want to explore, without needing to
label your own data.

The following docs detail how to launch the app and describe the individual tabs;
for more information on specific workflows, see the :ref:`User guides<user_guides>`.

**Launch the app**

Once you have opened the Lightning Pose App Studio, you will see the following:

.. image:: https://imgur.com/N351izy.png
    :width: 400

Make sure you are :ref:`connected to a GPU machine <faq_change_machine>` for non-labeling tasks.

First, open a terminal by using the drop-down menu at the top left and select
``Terminal > New Terminal``.

.. image:: https://imgur.com/ZqhpAhE.png
    :width: 400

To launch an app from the terminal, first move to the ``Pose-app`` directory:

.. code-block:: console

    cd Pose-app

and run:

.. code-block:: console

    lightning_app run app app.py

.. note::

    If you see the message "`lightning run model` is deprecated..." on the command line after
    trying to launch the app, you are running a newer version of lightning.
    In order to launch the app, instead run ``lightning_app run app app.py``.

.. note::

    You may get a message alerting you that a new version of Lightning is available.
    There is a possibility that upgrading will cause breaking changes, and you should always decline.
    If you **do** accidentally upgrade, see the :ref:`FAQ <faq_update_lightning_oops>` for how to
    reinstall the correct version.

Once the app launches you will begin to see printouts in the terminal.
Navigate to the app output by clicking on the "port" plugin on the right-hand tool bar
(see image below). In the Port Viewer, ensure that "LP Port" is set to port 7501. 
After confirming the port, click on it and allow the app to load.

.. image:: https://imgur.com/yy8AHS7.png
    :width: 600

Once the app has loaded, you can click on "Open" to launch the app in a new browser window or 
share a link to the app with your colleagues.

.. image:: https://imgur.com/lNk5ock.png
    :width: 600

IMPORTANT! We recommend opening the app in a separate browser window. This will ensure that all 
components are properly visualized. You can return to the terminal to see printouts by clicking on 
the VS Code icon in the right-hand toolbar.

If you have an older version of the app or can't find the Port Viewer or API Builder plugins, 
please see our :ref:`FAQ's section <faq_missing_port_viewer_api_builder>` for more information.

Click on the links below to find more information about specific tabs.

.. toctree::
   :maxdepth: 1
   :caption: App tabs:

   tabs/manage_project
   tabs/extract_frames
   tabs/label_frames
   tabs/train_infer
   tabs/train_status
   tabs/labeled_diagnostics
   tabs/fiftyone
   tabs/video_diagnostics
   tabs/video_player

**Close the app**

**To shut down the app**: return to the terminal/VS Code view of the Studio by clicking on
the appropriate icon in the right-hand tool bar (see image below), and type "ctrl+c" in the
terminal.

.. image:: https://imgur.com/lINajyE.png
    :width: 200

**To shut down the studio**: click on the compute icon in the right-hand tool bar and then click the power button.

.. image:: https://imgur.com/jsygRpO.png
    :width: 400