lightning-utilities

Lightning toolbox for across the our ecosystem.

Apache-2.0 37 个版本 Python >=3.10
Lightning AI et al. <developer@lightning.ai>
主页
Bug Tracker
Documentation
Download
Homepage
Source Code
安装
pip install lightning-utilities
poetry add lightning-utilities
pipenv install lightning-utilities
conda install lightning-utilities
描述

Lightning Utilities

PyPI Status license PyPI - Downloads PyPI - Python Version

UnitTests Apply checks Docs Status pre-commit.ci status

This repository covers the following use-cases:

  1. Reusable GitHub workflows
  2. Shared GitHub actions
  3. General Python utilities in lightning_utilities.core
  4. CLI python -m lightning_utilities.cli --help

1. Reusable workflows

Usage:

name: Check schema

on: [push]

jobs:

  check-schema:
    uses: Lightning-AI/utilities/.github/workflows/check-schema.yml@v0.5.0
    with:
      azure-dir: ""  # skip Azure check

  check-code:
    uses: Lightning-AI/utilities/.github/workflows/check-code.yml@main
    with:
      actions-ref: main  # normally you shall use the same version as the workflow

See usage of other workflows in .github/workflows/ci-use-checks.yaml.

2. Reusable composite actions

See available composite actions .github/actions/.

Usage:

name: Do something with cache

on: [push]

jobs:
  pytest:
    runs-on: ubuntu-24.04
    steps:
    - uses: actions/checkout@v3
    - uses: actions/setup-python@v4
      with:
        python-version: 3.10
    - uses: Lightning-AI/utilities/.github/actions/cache
      with:
        python-version: 3.10
        requires: oldest # or latest

3. General Python utilities lightning_utilities.core

Installation From source: 
pip install https://github.com/Lightning-AI/utilities/archive/refs/heads/main.zip

From pypi:

pip install lightning_utilities

Usage:

Example for optional imports:

from lightning_utilities.core.imports import module_available

if module_available("some_package.something"):
    from some_package import something

4. CLI lightning_utilities.cli

The package provides common CLI commands.

Installation

From pypi:

pip install lightning_utilities[cli]

Usage:

python -m lightning_utilities.cli [group] [command]
Example for setting min versions 
$ cat requirements/test.txt
coverage>=5.0
codecov>=2.1
pytest>=6.0
pytest-cov
pytest-timeout
$ python -m lightning_utilities.cli requirements set-oldest
$ cat requirements/test.txt
coverage==5.0
codecov==2.1
pytest==6.0
pytest-cov
pytest-timeout
分类
Development Status :: 3 - Alpha Environment :: Console Intended Audience :: Developers Natural Language :: English Operating System :: OS Independent Programming Language :: Python :: 3 Programming Language :: Python :: 3.10 Programming Language :: Python :: 3.11 Programming Language :: Python :: 3.12 Programming Language :: Python :: 3.13 Programming Language :: Python :: 3.14
版本列表
0.15.3 2026-02-22
0.15.2 2025-08-06
0.15.1 2025-08-04
0.15.0 2025-07-26
0.14.3 2025-04-03
0.14.2 2025-03-20
0.14.1 2025-03-16
0.14.0 2025-03-07
0.13.1 2025-03-04
0.13.0 2025-03-04
0.12.0 2025-01-31
0.12.0.dev0 2024-12-16
0.11.9 2024-11-19
0.11.8 2024-10-15
0.11.7 2024-09-02
0.11.6 2024-07-23
0.11.5 2024-07-15
0.11.4 2024-07-14
0.11.3 2024-06-26
0.11.3.post0 2024-06-26
0.11.2 2024-03-27
0.11.1 2024-03-25
0.11.0 2024-03-18
0.10.1 2024-01-18
0.10.0 2023-11-17
0.9.0 2023-06-29
0.8.0 2023-03-10
0.7.1 2023-02-22
0.7.0 2023-02-20
0.6.0 2023-01-23
0.6.0.post0 2023-01-25
0.5.0 2022-12-22
0.4.2 2022-11-25
0.4.1 2022-10-31
0.4.0 2022-10-28
0.3.0 2022-09-06
0.2.0 2022-09-06