securefederatedai / openfl

An open framework for Federated Learning.
https://openfl.readthedocs.io/en/latest/index.html
Apache License 2.0
686 stars 180 forks source link

Separate OpenFL samples and tutorials #354

Open alexey-gruzdev opened 2 years ago

alexey-gruzdev commented 2 years ago

We need to clearly separate OpenFL samples (which would just show how to integrate OpenFL and various use-cases) and tutorials or lifehachks (how to add your custom aggregation function/play with assigner/get_last_model(), get_best_model() and continue training, use data splitters or different agg functions like FedOpt/FedProx/etc.) just to have them in different places to avoid user's confusion.

mansishr commented 2 years ago

I also suggest listing down links to OpenFL examples and hacks as a part of the front page documentation for a more user friendly experience.