lightning/docs/source-app/api_references.rst

92 lines
1.6 KiB
ReStructuredText

:orphan:
##############################
Lightning App - API References
##############################
Core
____
.. currentmodule:: lightning_app.core
.. autosummary::
:toctree: api/
:nosignatures:
:template: classtemplate_no_index.rst
LightningApp
LightningFlow
LightningWork
Learn more about :ref:`Lightning Core <core_api>`.
----
Built-in Components
___________________
.. currentmodule:: lightning_app.components
.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate_no_index.rst
~python.popen.PopenPythonScript
~python.tracer.TracerPythonScript
~training.LightningTrainingComponent
~serve.gradio.ServeGradio
~serve.serve.ModelInferenceAPI
----
Frontend's
__________
.. currentmodule:: lightning_app.frontend
.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate_no_index.rst
~frontend.Frontend
~web.StaticWebFrontend
~stream_lit.StreamlitFrontend
Learn more about :ref:`Frontend's <ui_and_frontends>`.
----
Storage
_______
.. currentmodule:: lightning_app.storage
.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate_no_index.rst
~path.Path
~drive.Drive
~payload.Payload
Learn more about :ref:`Storage <storage>`.
----
Runners
_______
.. currentmodule:: lightning_app.runners
.. autosummary::
:toctree: generated/
:nosignatures:
:template: classtemplate_no_index.rst
~cloud.CloudRuntime
~singleprocess.SingleProcessRuntime
~multiprocess.MultiProcessRuntime