Ludwig API 保障

很高兴看到 Ludwig 已被创造性地集成到各种数据科学工作流和产品中。

为了更好地支持将 Ludwig 作为平台使用的工程师和科学家，Ludwig 在代码库中定义了稳定性保障和预期。为了在代码中明确 API 的稳定性，我们采用了以下 Python 装饰器。您可以在 Ludwig 代码库中的此模块中找到它们的 Python 实现。

PublicAPI¶

Public API 是向 Ludwig 最终用户公开的类和函数。PublicAPI 有两种类型，通过稳定性参数进行区分。如果未指定稳定性，则应假定为 stability=”stable”。

稳定的 PublicAPI 表示该 API 已成熟，在 Ludwig 的次要版本中不会更改或移除。它可能在主要版本中更改，但在更改之前的版本中会提供弃用消息。

实验性 PublicAPI 适用于仍在开发中的新公共功能。这些 API 应由能够容忍并预期破坏性更改的高级用户使用。它们很可能在接下来的 1-2 个 Ludwig 版本中得到强化并成为稳定的 PublicAPI。

Developer API 是明确向高级 Ludwig 用户和库开发者公开的更底层方法。它们的接口可能在 Ludwig 的次要版本中发生更改。

已弃用的 API 可能在 Ludwig 的未来版本中移除。弃用注解将包含一条消息，提供推荐的替代方案，例如当函数已移至不同的导入路径，或函数的参数已更改时。