package_structure.md

Package Structure

[TOC]

Overview

Terminology

Python Module

A Python module is a file containing Python definitions and statements. See modules for more information.

Python Package

Python packages are a way of structuring Python modules. See packages for more information.

Public TFF API

The TFF API that is exposed by the TFF API documentation; this documentation is generated with TensorFlow Docs using the logic defined by the explicit_package_contents_filter

Private TFF API

The TFF API that that is not exposed in the TFF TFF API documentation.

TFF Python package

The Python package distributed on https://pypi.org.

Please be aware, the Python package contains both public TFF API and private TFF API and it is not obvious by inspecting the package which API is intended to be public and which is intended to be private, for example:

import tensorflow_federated as tff

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

Therefore, it is useful to keep the TFF API documentation in mind when using TFF.

Diagrams

Overview

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

Simulation

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

Learning

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

Analytics

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

Core

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