search

Substra / substra-documentation

Documentation of the Substra software
https://docs.substra.org/
Apache License 2.0
21 stars 10 forks source link

feat: cyclic example #326

Closed ThibaultFy closed 1 year ago

ThibaultFy commented 1 year ago

Summary

This example aims to explain how to implement a custom strategy, taking the MNIST dataset and choosing the cyclic strategy as the one to test.

To run the example, git switch chore/update-identifiers in substrafl as the feature as not been merged yet.

Companion PR:

Blocked by https://github.com/Substra/substrafl/pull/142

closes FL-632

linear[bot] commented 1 year ago
FL-632 [Flex API] - Example (or how to guide?) on how to write FL strat

Context and user need: Add documentation example on how to create a FL Strategy using the ComputePlanBuilder class. See [https://www.notion.so/owkin-fdn/Federated-Analytics-in-SubstraFL-5685c4f2549748a89a3ad2e314cde886?pvs=4](https://www.notion.so/owkin-fdn/Federated-Analytics-in-SubstraFL-5685c4f2549748a89a3ad2e314cde886?pvs=4) for more info. Functional spec: Write the example in the SubstraFL "go further" section. Strategy TBD with product Dataset TDB with product. Technical spec: Acceptance criteria:

ThibaultFy commented 1 year ago

would

Thanks a lot for the review. Fully agree that its the unclear part. But the more I try to explain it, the more it's becoming obvious that it's the wrong abstraction... I added a few lines after the warning section, just before the instantiation of objects. Let me know what you think about it...