Skip to content

Commit

Permalink
📃 docs(readme): Update
Browse files Browse the repository at this point in the history
  • Loading branch information
KarhouTam committed Jun 11, 2024
1 parent d7a47a6 commit 655e64d
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<p align="center">
<img src=".github/images/logo.svg" alt="Image"/>
</p>

<!--
<p align="center">
<a href="https://github.com/KarhouTam/FL-bench/blob/master/LICENSE">
<img alt="GitHub License" src="https://img.shields.io/github/license/KarhouTam/FL-bench?style=for-the-badge&logo=github&color=8386e0"/>
Expand All @@ -16,9 +16,10 @@
<img alt="GitHub Repo forks" src="https://img.shields.io/github/forks/KarhouTam/FL-bench?style=for-the-badge&logo=github&color=8386e0">
</a>
</p>
-->
<h4 align="center"><i>
Evaluating Federated Learning Methods.

Benchmarking Federated Learning Methods.

Realizing Your Brilliant Ideas.

Expand Down Expand Up @@ -315,20 +316,22 @@ About the default values of specific FL method arguments, go check corresponding



## Supported Models 🚀
## Models 🤖

This benchmark supports bunch of models that common and integrated in Torchvision:
This benchmark supports bunch of models that common and integrated in Torchvision (check [here](src/utils/models.py) for all):

- ResNet family
- EfficientNet family
- DenseNet family
- MobileNet family
- LeNet5
...
- ...



🤗 You can define your own custom model by filling the `CustomModel` class in [`src/utils/models.py`](src/utils/models.py) and use it by defining `model: custom`.
🤗 You can define your own custom model by filling the `CustomModel` class in [`src/utils/models.py`](src/utils/models.py) and use it by defining `model: custom` in your `.yaml` config file.

## Supported Datasets 🎨
## Datasets and [Partition Strategies](data/README.md) 🎨

Regular Image Datasets

Expand Down

0 comments on commit 655e64d

Please sign in to comment.