Skip to content

Commit 3712e30

Browse files
committed
Add app screenshots (work in progress)
1 parent 22c4f4e commit 3712e30

11 files changed

+40
-10
lines changed
217 KB
Loading
313 KB
Loading
145 KB
Loading
621 KB
Loading
403 KB
Loading
427 KB
Loading
89.1 KB
Loading
437 KB
Loading
279 KB
Loading

docs/source/create_first_project.rst

Lines changed: 40 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,34 @@ Create your first project
44
Now that you've installed Lightning Pose and understood the core concepts,
55
you're ready to create your first project.
66

7-
This tutorial assumes you are starting with only videos and want to label frames
8-
and train models. If you have labels, see `<importing_labeled_data>`_.
9-
107
Run the app
118
---------------
129

1310
From a command line, activate your conda environment and run:
1411

1512
.. code-block:: console
1613
17-
litpose run_app
14+
$ litpose run_app
1815
1916
You should see some output that says the server is running on port 8000.
2017
Now that the server is running, open a web browser and navigate to
2118
``http://localhost:8000`` if you ran the server on your local machine,
2219
or replace ``localhost`` with the IP address of the machine where you ran the app.
2320

24-
In cloud environments, the cloud provider has some mechanism for opening the port
25-
and providing a link for you to access it. In Lightning Studio, this is done
26-
using the Port icon on the right hand side.
21+
.. note::
22+
In cloud environments, the cloud provider has some mechanism for opening the port
23+
and providing a link for you to access it. In Lightning Studio, this is done
24+
using the Port icon on the right hand side.
2725

2826
Once the app is open in the browser, it should look like this:
2927

28+
.. image:: /images/app_screenshots/app_new_project_page.png
29+
3030
Then, click on New Project and begin to fill out the form.
3131

32+
.. image:: /images/app_screenshots/app_new_project_form.png
33+
34+
3235
Data directory
3336
~~~~~~~~~~~~~~
3437

@@ -49,7 +52,10 @@ leave this blank**. For multiple views, **your videos must end in _viewname as
4952
the suffix**. This convention is relied upon for Lightning Pose to
5053
extract the View name and Session name from a video's filename.
5154

52-
That's it! Hit save and your project will be created.
55+
That's it! Hit save and your project will be created. You will be redirected
56+
to the project home page.
57+
58+
.. image:: /images/app_screenshots/app_project_home.png
5359

5460
Label data
5561
-----------
@@ -59,21 +65,41 @@ If you have labels, see `<importing_labeled_data>`_.
5965

6066
Labeling occurs in the Labeler module.
6167

68+
.. image:: /images/app_screenshots/app_labeler_home.png
69+
70+
6271
Create a label file and extract frames
6372
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
6473

6574
Start by creating a Label file left side green button.
6675
This opens the "extract frames" workflow:
67-
- name your label file
76+
- name your label file (leave it as the default)
6877
- upload a session for frame extraction
6978
- specify frame extraction settings
7079

80+
.. image:: /images/app_screenshots/app_extract_frames_name_lblfile.png
81+
82+
Leave the default name and click next. You will see the session selection screen.
83+
On the right, click Upload Session.
84+
85+
.. image:: /images/app_screenshots/app_extract_frames_2_select_session.png
86+
87+
Select videos from your local filesystem and click Import.
88+
Videos will upload and be transcoded. Upon completion, the video import dialog
89+
will close and you will be able to see and select the newly uploaded session on the
90+
left hand side of the session selection screen.
91+
92+
.. image:: /images/app_screenshots/app_session_import_successful.png
93+
94+
7195
Label frames
7296
~~~~~~~~~~~~
7397

7498
Click an unlabeled frame on the left and start labeling.
7599
You need to hit save in order to persist the label file.
76100

101+
.. image:: /images/app_screenshots/app_labeler_with_unlabeled_frame_loaded.png
102+
77103
Explainer: Label files
78104
~~~~~~~~~~~~~~~~~~~~~~~~~
79105

@@ -99,7 +125,11 @@ the remaining views. See the in product documentation here for more information.
99125
Create a model
100126
----------------
101127

102-
This doc is a work in progress.
128+
In the Models module, click New Model and follow the instructions to create a model.
129+
Training will begin automatically.
130+
131+
.. image:: /images/app_screenshots/app_model_creation_form.png
132+
103133

104134
Visualize predictions
105135
----------------------

0 commit comments

Comments
 (0)