Skip to content

Latest commit

 

History

History
92 lines (64 loc) · 1.58 KB

api_references.rst

File metadata and controls

92 lines (64 loc) · 1.58 KB
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.LightningTrainerScript
    ~serve.gradio.ServeGradio
    ~serve.serve.ModelInferenceAPI
    ~auto_scaler.AutoScaler


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