Skip to content

Commit

Permalink
lightning studio docs
Browse files Browse the repository at this point in the history
  • Loading branch information
themattinthehatt committed Nov 30, 2023
1 parent 15e5258 commit 4c730d3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
17 changes: 16 additions & 1 deletion docs/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,14 @@ NVIDIA DALI dependency. You must have **CUDA 11.0-12.x** installed.
If you have a Mac OS and would like to install Lightning Pose, please get in contact by
`raising an issue <https://github.com/danbider/lightning-pose/issues>`_.

There are two installation methods:
There are several installation methods:

* :ref:`pip package <pip_package>` provides the basic Lightning Pose package. This option is intended for non-interactive environments, such as remote servers.

* :ref:`conda from source <conda_from_source>` additionally provides example data, a boilerplate training script, and diagnostic visualization scripts. This option is the recommended one for new users, as it provides the full breadth of Lightning Pose capabilities.

* :ref:`Lightning Studio <lightning_studio>` is a cloud-based environment that comes with Lightning Pose already installed. Requires creating a Lightning.ai account.

Optionally, instructions are provided for :ref:`Docker users <docker_users>`.

**Install ffmpeg**
Expand Down Expand Up @@ -115,6 +117,19 @@ Method 2: conda from source
This will take several minutes.

.. _lightning_studio:

Method 3: Lightning Studio
==========================

Follow
`this link <https://lightning.ai/themattinthehatt/ai-recipes/lightning-pose-v1-0-1~01hgghkdmdpz60ttys95n61852>`_
to the Lightning Pose Studio.
When you click the **Use** button you will be taken to a Lightning Studio environment with access to a command line interface, VSCode IDE, Jupyter IDE, and more.
The ``lightning-pose`` package and all dependencies are already installed.

You will be required to create a Lightning account if you have not already signed up.

.. _docker_users:

Docker users
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

from setuptools import find_packages, setup

VERSION = "1.0.0"
VERSION = "1.0.1"

# add the README.md file to the long_description
with open("README.md", "r") as fh:
Expand Down

0 comments on commit 4c730d3

Please sign in to comment.