Skip to content

Commit

Permalink
Update the GitHub repository URL for TFF.
Browse files Browse the repository at this point in the history
PiperOrigin-RevId: 634858992
  • Loading branch information
michaelreneer authored and copybara-github committed May 17, 2024
1 parent 0ce018a commit c069fc5
Show file tree
Hide file tree
Showing 34 changed files with 212 additions and 205 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ authors:
title: "TensorFlow Federated"
version: 0.78.0
date-released: 2018-12-12
url: "https://github.com/tensorflow/federated"
url: "https://github.com/google-parfait/tensorflow-federated"
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ information on using pull requests.
## Collaborations

If you are interested in collaborating to grow the TFF ecosystem, please see the
[collaborations page](https://github.com/tensorflow/federated/blob/main/docs/collaborations/README.md)
[collaborations page](https://github.com/google-parfait/tensorflow-federated/blob/main/docs/collaborations/README.md)
and/or join our [Discord server](https://discord.com/invite/5shux83qZ5) to
engage in conversations with other developers building on or contributing to the
TFF ecosystem.
Expand Down Expand Up @@ -80,7 +80,7 @@ git diff --name-only \

Include a license at the top of new files.

* [Python license example](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/__init__.py#L1)
* [Python license example](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/__init__.py#L1)

### TensorFlow Guidelines.

Expand Down
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,12 +17,12 @@ computations, such as aggregated analytics over decentralized data.

TFF's interfaces are organized in two layers:

* [Federated Learning (FL) API](https://github.com/tensorflow/federated/blob/main/docs/federated_learning.md)
* [Federated Learning (FL) API](https://github.com/google-parfait/tensorflow-federated/blob/main/docs/federated_learning.md)
The `tff.learning` layer offers a set of high-level interfaces that allow
developers to apply the included implementations of federated training and
evaluation to their existing TensorFlow models.

* [Federated Core (FC) API](https://github.com/tensorflow/federated/blob/main/docs/federated_core.md)
* [Federated Core (FC) API](https://github.com/google-parfait/tensorflow-federated/blob/main/docs/federated_core.md)
At the core of the system is a set of lower-level interfaces for concisely
expressing novel federated algorithms by combining TensorFlow with
distributed communication operators within a strongly-typed functional
Expand All @@ -37,14 +37,14 @@ and try it out yourself!
## Installation

See the
[install](https://github.com/tensorflow/federated/blob/main/docs/install.md)
[install](https://github.com/google-parfait/tensorflow-federated/blob/main/docs/install.md)
documentation for instructions on how to install TensorFlow Federated as a
package or build TensorFlow Federated from source.

## Getting Started

See the
[get started](https://github.com/tensorflow/federated/blob/main/docs/get_started.md)
[get started](https://github.com/google-parfait/tensorflow-federated/blob/main/docs/get_started.md)
documentation for instructions on how to use TensorFlow Federated.

## Contributing
Expand Down Expand Up @@ -80,13 +80,14 @@ There are a number of ways to contribute depending on what you're interested in:
infrastructure.

Please be sure to review the
[contribution](https://github.com/tensorflow/federated/blob/main/CONTRIBUTING.md#guidelines)
[contribution](https://github.com/google-parfait/tensorflow-federated/blob/main/CONTRIBUTING.md#guidelines)
guidelines on how to contribute.

## Issues

Use [GitHub issues](https://github.com/tensorflow/federated/issues) for tracking
requests and bugs.
Use
[GitHub issues](https://github.com/google-parfait/tensorflow-federated/issues)
for tracking requests and bugs.

## Questions

Expand Down
2 changes: 2 additions & 0 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
## Breaking Changes

* Updated `com_github_grpc_grpc` to version `1.50.0`.
* Moved the TFF repository from https://github.com/tensorflow/federated to
https://github.com/google-parfait/tensorflow-federated.

# Release 0.78.0

Expand Down
2 changes: 1 addition & 1 deletion WORKSPACE
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ http_archive(
# )

# The version of TensorFlow should match the version in
# https://github.com/tensorflow/federated/blob/main/requirements.txt.
# https://github.com/google-parfait/tensorflow-federated/blob/main/requirements.txt.
http_archive(
name = "org_tensorflow",
url = "https://github.com/tensorflow/tensorflow/archive/refs/tags/v2.14.0.tar.gz",
Expand Down
4 changes: 2 additions & 2 deletions docs/_index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -127,10 +127,10 @@ landing_page:
items:
- heading: "TF Federated on GitHub"
image_path: /resources/images/github-card-16x9.png
path: https://github.com/tensorflow/federated
path: https://github.com/google-parfait/tensorflow-federated
buttons:
- label: "View on GitHub"
path: https://github.com/tensorflow/federated
path: https://github.com/google-parfait/tensorflow-federated
- heading: "Federated Learning: Collaborative Machine Learning without Centralized Training Data"
image_path: /resources/images/google-research-card-16x9.png
path: https://ai.googleblog.com/2017/04/federated-learning-collaborative.html
Expand Down
2 changes: 1 addition & 1 deletion docs/collaborations/notes/2022-02-16.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@
* [ostrowski] Communicating openly

* What to make publicly available (on
[the GitHub landing page](https://github.com/tensorflow/federated/blob/main/docs/collaborations/README.md))
[the GitHub landing page](https://github.com/google-parfait/tensorflow-federated/blob/main/docs/collaborations/README.md))
* Summary of discussions and decisions from this and follow-up meetings to
be made available within a few days after each meeting on th GitHub page
* Links to artifacts (any plans, roadmaps, design docs, etc. to be
Expand Down
2 changes: 1 addition & 1 deletion docs/collaborations/notes/2022-09.29.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
* Suspects: TFF setup cost, communication
* Overlapping data ingestion and computation likely to help
* Code to support this upcoming
* https://github.com/tensorflow/federated/blob/main/tensorflow\_federated/python/program/prefetching\_data\_source.py
* https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow\_federated/python/program/prefetching\_data\_source.py
* Discussion continued on the Discord server
* Versioning - also relevant to OpenMined (need to resolve 3-way)
* To discuss at a future meeting
4 changes: 2 additions & 2 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ There are two principal modes of deployment for TFF computations:
* **Native backends**. We're going to refer to a backend as *native* if it is
capable of interpreting the syntactic structure of TFF computations as
defined in
[`computation.proto`](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/proto/v0/computation.proto).
[`computation.proto`](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/proto/v0/computation.proto).
A native backend does not necessarily have to support all language
constructs or intrinsics. Native backends must implement one of the standard
TFF *executor* interfaces, such as
[`tff.framework.Executor`](https://www.tensorflow.org/federated/api_docs/python/tff/framework/Executor)
for consumption by Python code, or the language-independent version of it
defined in
[`executor.proto`](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/proto/v0/executor.proto)
[`executor.proto`](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/proto/v0/executor.proto)
exposed as a gRPC endpoint.

Native backends that support the above interfaces can be used interactively
Expand Down
20 changes: 10 additions & 10 deletions docs/design/backend.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ an [AST](compilation.md#ast), meaning a backend constructs environments that
evaluate an AST.

The
[backends](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends)
[backends](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends)
package contains backends which may extend the TFF compiler and/or the TFF
runtime; these extensions can be found in the corresponding backend.

Expand All @@ -27,7 +27,7 @@ low-level abstraction.
```

The **blue** nodes are provided by TFF
[core](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core).
[core](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core).

The **green**, **red**, **yellow**, and **purple** nodes are provided by the
[native](#native), [mapreduce](#mapreduce), and [reference](#reference) backends
Expand All @@ -41,7 +41,7 @@ inheritance.
## Native

The
[native](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/native)
[native](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/native)
backend composes of the TFF compiler and TFF runtime in order to compile and
execute an AST in a way that is reasonably efficient and debuggable.

Expand All @@ -54,7 +54,7 @@ intrinsics.
### Compiler

The
[compiler.transform_to_native_form](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/native/compiler.py)
[compiler.transform_to_native_form](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/native/compiler.py)
function compiles an AST into a [native form](#native-form).

### Runtime
Expand All @@ -81,37 +81,37 @@ set_default_context.set_default_context(context)
However, there are some common configurations:

The
[execution_context.set_sync_local_cpp_execution_context](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/native/execution_context.py)
[execution_context.set_sync_local_cpp_execution_context](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/native/execution_context.py)
function constructs an `ExecutionContext` with a native compiler and a
[local execution stack](execution.md#local-execution-stack).

## MapReduce

The
[mapreduce](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/mapreduce)
[mapreduce](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/mapreduce)
backend contains the data structures and compiler required to construct a form
that can be executed on MapReduce-like runtimes.

### `MapReduceForm`

A
[forms.MapReduceForm](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/forms.py)
[forms.MapReduceForm](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/forms.py)
is a data structure defining the representation of logic that can be executed on
MapReduce-like runtimes. This logic is organized as a collection of TensorFlow
functions, see the
[forms](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/forms.py)
[forms](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/forms.py)
module for more information about the nature of these functions.

### Compiler

The
[compiler](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/compiler.py)
[compiler](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/compiler.py)
module contains [Building Block](compilation.md#building-block) and
[TensorFlow Computation](compilation.md#tensorflow-computation) transformations
required to compile an AST to a [MapReduceForm](#canonicalform).

The
[form_utils](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/form_utils.py)
[form_utils](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/backends/mapreduce/form_utils.py)
module contains the compiler for the MapReduce backend and constructs a
[MapReduceForm](#canonicalform).

Expand Down
22 changes: 11 additions & 11 deletions docs/design/compilation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[TOC]

The
[compiler](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler)
[compiler](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler)
package contains data structures defining the Python representation of the
[AST](#ast), core [transformation](#transformation) functions, and
[compiler](#compiler) related functionality.
Expand All @@ -16,15 +16,15 @@ computation.
### Building Block

A
[building_block.ComputationBuildingBlock](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler/building_blocks.py)
[building_block.ComputationBuildingBlock](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler/building_blocks.py)
is the Python representation of the [AST](#ast).

#### `CompiledComputation`

A
[building_block.CompiledComputation](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler/building_blocks.py)
[building_block.CompiledComputation](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler/building_blocks.py)
is a
[building_block.ComputationBuildingBlock](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler/building_blocks.py)
[building_block.ComputationBuildingBlock](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler/building_blocks.py)
that represents a computation that will be delegated to an
[external runtime](execution.md#external-runtime). Currently TFF only supports
[TensorFlow computations](#tensorFlow-computation), but could be expanded to
Expand All @@ -33,13 +33,13 @@ support [Computations](#computation) backed by other external runtimes.
### `Computation`

A
[pb.Computation](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/proto/v0/computation.proto)
[pb.Computation](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/proto/v0/computation.proto)
is the Proto or serialized representation of the [AST](#ast).

#### TensorFlow Computation

A
[pb.Computation](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/proto/v0/computation.proto)
[pb.Computation](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/proto/v0/computation.proto)
that represents a [Computations](#computation) that will be delegated to the
[TensorFlow](execution.md#tensorflow) runtime.

Expand All @@ -66,25 +66,25 @@ about; as a result, composite transformations are hand-crafted and most are
somewhat fragile.

The
[tree_transformations](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler/tree_transformations.py)
[tree_transformations](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler/tree_transformations.py)
module contains atomic [building block](#building-block) transformations.

The
[transformations](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler/transformations.py)
[transformations](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler/transformations.py)
module contains composite [building block](#building-block) transformations.

The
[tensorflow_computation_transformations](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/environments/tensorflow_backend/tensorflow_computation_transformations.py)
[tensorflow_computation_transformations](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/environments/tensorflow_backend/tensorflow_computation_transformations.py)
module contains atomic [TensorFlow computation](#tensorflow-computation)
transformations.

The
[compiled_computation_transformations](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/environments/tensorflow_backend/compiled_computation_transformations.py)
[compiled_computation_transformations](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/environments/tensorflow_backend/compiled_computation_transformations.py)
module contains atomic and composite
[Compiled Computation](#compiled-computation) transformations.

The
[transformation_utils](https://github.com/tensorflow/federated/blob/main/tensorflow_federated/python/core/impl/compiler/transformation_utils.py)
[transformation_utils](https://github.com/google-parfait/tensorflow-federated/blob/main/tensorflow_federated/python/core/impl/compiler/transformation_utils.py)
module contains functions, traversal logic, and data structures used by other
transformation modules.

Expand Down
Loading

0 comments on commit c069fc5

Please sign in to comment.