flower
flower copied to clipboard
Improve code examples
Describe the type of feature and its functionality.
There's room for improvement when it comes to the general structure of our code examples. Issues include:
- inconsistent naming of code examples across different frameworks
- multiple code examples covering the same topic in different ways
- at least one obsolete code example
- inconsistent naming:
-vs_
Describe step by step what files and adjustments are you planning to include.
Here's a table of all code examples (see column 2 "Current name"). The proposed name for each code examples is shown in column 1 to make it easy to see what the final structure would look like. Empty rows divide the code examples covering PyTorch, TensorFlow, and everything else. The last column details the proposed next step for each example:
| Done | Proposed name | Current name | Framework | Topic | Next step |
|---|---|---|---|---|---|
| ☑️ | quickstart_pytorch |
quickstart_pytorch | PyTorch | quickstart | |
| - | pytorch_from... | PyTorch | from...to | ||
advanced_pytorch |
advanced_pytorch | PyTorch | advanced | make it faster | |
differential_privacy_pytorch |
opacus | PyTorch | dp | ||
simulation_pytorch |
simulation_pytorch | PyTorch | sim | ||
| ✅ | - | simulation_pytorch_legacy | PyTorch | sim | DELETE |
edge_pytorch |
embedded_devices | PyTorch | edge | ||
| - | pytorch_federated_variational_autoencode | PyTorch | application | ||
| --- | --- | --- | --- | --- | --- |
| ☑️ | quickstart_tensorflow |
quickstart_tensorflow | TensorFlow | quickstart | |
advanced_tensorflow |
advanced_tensorflow | TensorFlow | advanced | ||
differential_privacy_tensorflow |
dp-sgd-mnist | TensorFlow | dp | RENAME to differential_privacy_tensorflow | |
| ✅ | simulation_tensorflow |
quickstart_simulation | TensorFlow | sim | Rename to simulation_tensorflow |
| ✅ | - | simulation | TensorFlow | sim | DELETE |
edge_tensorflow |
android | TFLite | edge | ||
| --- | --- | --- | --- | --- | --- |
quickstart_cpp |
quickstart_cpp | C++ | quickstart | ||
quickstart_huggingface |
quickstart_huggingface | HuggingFace | quickstart | Question: rename to quickstart_transformers? |
|
quickstart_mlcube |
quickstart_mlcube | MLCube | quickstart | ||
| ☑️ | quickstart_mxnet |
quickstart_mxnet | MXNet | quickstart | |
quickstart_pytorch_lightning |
quickstart_pytorch_lightning | PyTorch Lightning | quickstart | Question: rename to quickstart_lightning? |
|
| ✅ | quickstart_jax |
jax_from... | JAX | from...to | RENAME TO quickstart_jax |
quickstart_scikit_learn |
sklearn-logred-mnist | scikit-learn | quickstart | RENAME to quickstart_scikit_learn |
|
| - | mxnet_from... | MXNet | from...to | options: delete, merge with quickstart_mxnet, rename to advanced_mxnet |
Is there something else you want to add?
Open questions:
- Should we use
_or-as separators? Proposal: use-because example names might be used in auto-generated URL's (which so far use-separators on flower.dev).