package_structure.md

软件包结构

[目录]

概述

术语

Python 模块

Python 模块是一个包含 Python 定义和语句的文件。请参阅模块，了解更多信息。

Python 软件包

Python 软件包是一种构建 Python 模块的方法。请参阅软件包，了解更多信息。

公共 TFF API

TTFF API 文档公开的 TFF API；本文档使用 TensorFlow Docs 通过由 explicit_package_contents_filter 定义的逻辑生成

私有 TFF API

TFF TFF API 文档中未公开的TFF API。

TFF Python 软件包

在 https://pypi.org 上分发的 Python 软件包。

请注意，Python 软件包同时包含公共 TFF API 和私有 TFF API，检查软件包无法明确哪些 API 是公共的，哪些是私有的，例如：

import tensorflow_federated as tff

tff.Computation  # Public TFF API
tff.proto.v0.computation_pb2.Computation  # Private TFF API

因此，在使用 TFF 时维护 TFF API 文档十分有用。

图表

概览

<!--#include file="package_structure_overview.dot"-->

模拟

<!--#include file="package_structure_simulation.dot"-->

学习

<!--#include file="package_structure_learning.dot"-->

分析

<!--#include file="package_structure_analytics.dot"-->

核心

<!--#include file="package_structure_core.dot"-->