• Docs >
  • Lightning App - API References
Shortcuts

Lightning App - API References

Core

LightningApp

The Lightning App, or App in short runs a tree of one or more components that interact to create end-to-end applications.

LightningFlow

The LightningFlow is used by the LightningApp to coordinate and manage long- running jobs contained, the LightningWork.

LightningWork

LightningWork, or Work in short, is a building block for long-running jobs.

Learn more about Lightning Core.


Built-in Components

DatabaseClient

Database

The Database Component enables to interact with an SQLite database to store some structured information about your application.

PopenPythonScript

The PopenPythonScript component enables to easily run a python script within a subprocess.

TracerPythonScript

The TracerPythonScript class enables to easily run a python script.

LightningTrainerScript

This component enables performing distributed multi-node multi-device training.

ServeGradio

The ServeGradio Class enables to quickly create a gradio based UI for your LightningApp.

ModelInferenceAPI

The ModelInferenceAPI Class enables to easily get your model served.

PythonServer

The PythonServer Class enables to easily get your machine learning server up and running.

ServeStreamlit

The ServeStreamlit work allows you to use streamlit from a work.

MultiNode

This component enables performing distributed multi-node multi-device training.

LiteMultiNode

This component enables performing distributed multi-node multi-device training.

PyTorchSpawnMultiNode

This component enables performing distributed multi-node multi-device training.

LightningTrainerMultiNode

This component enables performing distributed multi-node multi-device training.

AutoScaler

The AutoScaler can be used to automatically change the number of replicas of the given server in response to changes in the number of incoming requests.

ColdStartProxy

ColdStartProxy allows users to configure the load balancer to use a proxy service while the work is cold starting.


Frontend’s

Frontend

Base class for any frontend that gets exposed by LightningFlows.

StaticWebFrontend

A frontend that serves static files from a directory using FastAPI.

StreamlitFrontend

A frontend for wrapping Streamlit code in your LightingFlow.

Learn more about Frontend’s.


Storage

Path

A drop-in replacement for pathlib.Path for all paths in Lightning.

Drive

The Drive object provides a shared space to write and read files from.

Payload

The Payload object enables to transfer python objects from one work to another in a similar fashion as Path.

Mount

Allows you to mount the contents of an AWS S3 bucket on disk when running an app on the cloud.

Learn more about Storage.


Runners

CloudRuntime

MultiProcessRuntime

Runtime to launch the LightningApp into multiple processes.


lightning_app.utilities.packaging

CloudCompute

Configure the cloud runtime for a lightning work or flow.

BuildConfig

The Build Configuration describes how the environment a LightningWork runs in should be set up.