Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

modify README #6

Merged
merged 1 commit into from
Apr 7, 2022
+4 −4
Merged

modify README #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

FederatedScope is a comprehensive federated learning platform that provides convenient usage and supports flexible custom for various federated learning tasks in both academic and industrial. Based on a message-oriented framework, FederatedScope integrates rich collections of fundamental functionalities to satisfy the burgeoning demands from federated learning, and aims to build up an easy-to-use platform for promoting learning safely and effectively.

**A detailed tutorial is coming soon!**
A detailed tutorial is ptovided in [Tutorial](https://federatedscope.io/).

## Quick Start

We provide an end-to-end example for users to start running a standard FL task with FederatedScope.
We provide an end-to-end example for users to start running a standard FL course with FederatedScope.

### Step 1. Installation

Expand Down Expand Up @@ -145,7 +145,7 @@ As a comprehensive FL platform, FederatedScope provides the fundamental implemen
- **Differential Privacy**: Different from the encrypted algorithms that require powerful computation ability, differential privacy is an economical yet flexible technique to protect privacy, which has achieved great success in database and is ever-growing in federated learning.
- ...

More supports are coming soon! We are also preparing a tutorial to provide more details about how to utilize FederatedScope to enjoy your journey of Federated Learning.
More supports are coming soon! We have prepared a [tutorial](https://federatedscope.io/) to provide more details about how to utilize FederatedScope to enjoy your journey of Federated Learning.

## Documentation

Expand All @@ -156,7 +156,7 @@ pip install -r requirements-doc.txt
make html
```

We shall put the API references and comprehensive tutorials on our website (coming soon).
We put the API references and comprehensive tutorials on our [website](https://federatedscope.io/).

## License

Expand Down