package_structure.md

Estrutura de pacotes

[TOC]

Visão geral

Terminologia

Módulo do Python

Um módulo do Python é um arquivo que contém definições e declarações do Python. Confira mais informações em módulos .

Pacote do Python

Os pacotes do Python são uma forma de estruturar os módulos do Python. Confira mais informações em pacotes .

API pública do TFF

API do TFF que é exposta pela documentação da API do TFF. Essa documentação é gerada com o TensorFlow Docs usando a lógica definia pelo explicit_package_contents_filter (filtro explícito de conteúdos do pacote).

API privada do TFF

API do TFF que não é exposta na documentação do API do TFF.

Pacote do Python no TFF

Pacote do Python distribuído em https://pypi.org.

Atenção: o pacote do Python contém tanto a API pública do TFF quanto a API privada do TFF, e ao analisar o pacote, não é óbvio qual API deve ser pública e qual deve ser privada. Por exemplo:

import tensorflow_federated as tff

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

Portanto, é importante ter em mente a documentação da API do TFF ao usar o TFF.

Diagramas

Visão geral

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

Simulação

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

Aprendizado

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

Análise

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

Core

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