From 4c730d34e4bb3fe6700ee6ce909190c119785bbf Mon Sep 17 00:00:00 2001 From: themattinthehatt Date: Thu, 30 Nov 2023 13:50:55 -0500 Subject: [PATCH] lightning studio docs --- docs/source/installation.rst | 17 ++++++++++++++++- setup.py | 2 +- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/docs/source/installation.rst b/docs/source/installation.rst index ee5e5f76..16d0a3cf 100644 --- a/docs/source/installation.rst +++ b/docs/source/installation.rst @@ -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 `_. -There are two installation methods: +There are several installation methods: * :ref:`pip package ` provides the basic Lightning Pose package. This option is intended for non-interactive environments, such as remote servers. * :ref:`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 ` 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 `. **Install ffmpeg** @@ -115,6 +117,19 @@ Method 2: conda from source This will take several minutes. +.. _lightning_studio: + +Method 3: Lightning Studio +========================== + +Follow +`this link `_ +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 diff --git a/setup.py b/setup.py index f8cabbcd..50140157 100644 --- a/setup.py +++ b/setup.py @@ -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: