package_structure.md

パッケージの構造

[目次]

概要

用語

Python モジュール

Python モジュールは、Python の定義とステートメントを含むファイルです。詳細は、「モジュール」を参照してください。

Python パッケージ

Python パッケージは、Python モジュールを構造化する手法です。詳細は、「パッケージ」を参照してください。

パブリック TFF API

TFF API ドキュメントで公開されている TFF API です。このドキュメントは、explicit_package_contents_filter が定義するロジックを使用して TensorFlow Docs によって生成されます。

プライベート TFF API

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"-->