Skip to content
This repository has been archived by the owner on Feb 14, 2024. It is now read-only.

Commit

Permalink
further explain the repository
Browse files Browse the repository at this point in the history
  • Loading branch information
SichangHe committed Jul 27, 2023
1 parent 23d339d commit 2c1a436
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 13 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# FedKit

Federated Learning (FL) and Federated Analytics (FA) development kit for FedCampus.

This repository contains the libraries used to implement the FL and FA functionalities of the FedCampus app.

## Architecture

### Backend
Expand Down
6 changes: 5 additions & 1 deletion client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Download the training and testing data from <https://www.dropbox.com/s/coeixr4kh

Set up and start the backend server according to `Set up` and `Development` sections in `../backend/README.md`.

Install the app on *physical* Android devices and launch it.
Install `app` on *physical* Android devices and launch it.

*Note*: the highest tested JDK version the app supports is 16; it fails to build using JDK 19 on macOS.

Expand All @@ -24,3 +24,7 @@ Push the second button and connect to the backend server. This should take littl
Push the first button and load the dataset. This may take a minute.

Push the last button and start the training.

## Note on other code

This directory also contains the Android library code used to implement `app` and a benchmark app.
15 changes: 3 additions & 12 deletions fed_kit_client/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
# fed_kit_client

A new Flutter project.
A Flutter example client using FedKit.

## Getting Started
This example has the same functionality as the example Android client, except that the UI is written using Flutter.

This project is a starting point for a Flutter application.

A few resources to get you started if this is your first Flutter project:

- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)

For help getting started with Flutter development, view the
[online documentation](https://docs.flutter.dev/), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
- [ ] Make it work on iOS.

0 comments on commit 2c1a436

Please sign in to comment.