[{"data":1,"prerenderedAt":-1},["ShallowReactive",2],{"similar-KarhouTam--FL-bench":3,"tool-KarhouTam--FL-bench":61},[4,18,26,36,44,52],{"id":5,"name":6,"github_repo":7,"description_zh":8,"stars":9,"difficulty_score":10,"last_commit_at":11,"category_tags":12,"status":17},4358,"openclaw","openclaw\u002Fopenclaw","OpenClaw 是一款专为个人打造的本地化 AI 助手，旨在让你在自己的设备上拥有完全可控的智能伙伴。它打破了传统 AI 助手局限于特定网页或应用的束缚，能够直接接入你日常使用的各类通讯渠道，包括微信、WhatsApp、Telegram、Discord、iMessage 等数十种平台。无论你在哪个聊天软件中发送消息，OpenClaw 都能即时响应，甚至支持在 macOS、iOS 和 Android 设备上进行语音交互，并提供实时的画布渲染功能供你操控。\n\n这款工具主要解决了用户对数据隐私、响应速度以及“始终在线”体验的需求。通过将 AI 部署在本地，用户无需依赖云端服务即可享受快速、私密的智能辅助，真正实现了“你的数据，你做主”。其独特的技术亮点在于强大的网关架构，将控制平面与核心助手分离，确保跨平台通信的流畅性与扩展性。\n\nOpenClaw 非常适合希望构建个性化工作流的技术爱好者、开发者，以及注重隐私保护且不愿被单一生态绑定的普通用户。只要具备基础的终端操作能力（支持 macOS、Linux 及 Windows WSL2），即可通过简单的命令行引导完成部署。如果你渴望拥有一个懂你",349277,3,"2026-04-06T06:32:30",[13,14,15,16],"Agent","开发框架","图像","数据工具","ready",{"id":19,"name":20,"github_repo":21,"description_zh":22,"stars":23,"difficulty_score":10,"last_commit_at":24,"category_tags":25,"status":17},3808,"stable-diffusion-webui","AUTOMATIC1111\u002Fstable-diffusion-webui","stable-diffusion-webui 是一个基于 Gradio 构建的网页版操作界面，旨在让用户能够轻松地在本地运行和使用强大的 Stable Diffusion 图像生成模型。它解决了原始模型依赖命令行、操作门槛高且功能分散的痛点，将复杂的 AI 绘图流程整合进一个直观易用的图形化平台。\n\n无论是希望快速上手的普通创作者、需要精细控制画面细节的设计师，还是想要深入探索模型潜力的开发者与研究人员，都能从中获益。其核心亮点在于极高的功能丰富度：不仅支持文生图、图生图、局部重绘（Inpainting）和外绘（Outpainting）等基础模式，还独创了注意力机制调整、提示词矩阵、负向提示词以及“高清修复”等高级功能。此外，它内置了 GFPGAN 和 CodeFormer 等人脸修复工具，支持多种神经网络放大算法，并允许用户通过插件系统无限扩展能力。即使是显存有限的设备，stable-diffusion-webui 也提供了相应的优化选项，让高质量的 AI 艺术创作变得触手可及。",162132,"2026-04-05T11:01:52",[14,15,13],{"id":27,"name":28,"github_repo":29,"description_zh":30,"stars":31,"difficulty_score":32,"last_commit_at":33,"category_tags":34,"status":17},1381,"everything-claude-code","affaan-m\u002Feverything-claude-code","everything-claude-code 是一套专为 AI 编程助手（如 Claude Code、Codex、Cursor 等）打造的高性能优化系统。它不仅仅是一组配置文件，而是一个经过长期实战打磨的完整框架，旨在解决 AI 代理在实际开发中面临的效率低下、记忆丢失、安全隐患及缺乏持续学习能力等核心痛点。\n\n通过引入技能模块化、直觉增强、记忆持久化机制以及内置的安全扫描功能，everything-claude-code 能显著提升 AI 在复杂任务中的表现，帮助开发者构建更稳定、更智能的生产级 AI 代理。其独特的“研究优先”开发理念和针对 Token 消耗的优化策略，使得模型响应更快、成本更低，同时有效防御潜在的攻击向量。\n\n这套工具特别适合软件开发者、AI 研究人员以及希望深度定制 AI 工作流的技术团队使用。无论您是在构建大型代码库，还是需要 AI 协助进行安全审计与自动化测试，everything-claude-code 都能提供强大的底层支持。作为一个曾荣获 Anthropic 黑客大奖的开源项目，它融合了多语言支持与丰富的实战钩子（hooks），让 AI 真正成长为懂上",141543,2,"2026-04-06T11:32:54",[14,13,35],"语言模型",{"id":37,"name":38,"github_repo":39,"description_zh":40,"stars":41,"difficulty_score":32,"last_commit_at":42,"category_tags":43,"status":17},2271,"ComfyUI","Comfy-Org\u002FComfyUI","ComfyUI 是一款功能强大且高度模块化的视觉 AI 引擎，专为设计和执行复杂的 Stable Diffusion 图像生成流程而打造。它摒弃了传统的代码编写模式，采用直观的节点式流程图界面，让用户通过连接不同的功能模块即可构建个性化的生成管线。\n\n这一设计巧妙解决了高级 AI 绘图工作流配置复杂、灵活性不足的痛点。用户无需具备编程背景，也能自由组合模型、调整参数并实时预览效果，轻松实现从基础文生图到多步骤高清修复等各类复杂任务。ComfyUI 拥有极佳的兼容性，不仅支持 Windows、macOS 和 Linux 全平台，还广泛适配 NVIDIA、AMD、Intel 及苹果 Silicon 等多种硬件架构，并率先支持 SDXL、Flux、SD3 等前沿模型。\n\n无论是希望深入探索算法潜力的研究人员和开发者，还是追求极致创作自由度的设计师与资深 AI 绘画爱好者，ComfyUI 都能提供强大的支持。其独特的模块化架构允许社区不断扩展新功能，使其成为当前最灵活、生态最丰富的开源扩散模型工具之一，帮助用户将创意高效转化为现实。",107888,"2026-04-06T11:32:50",[14,15,13],{"id":45,"name":46,"github_repo":47,"description_zh":48,"stars":49,"difficulty_score":10,"last_commit_at":50,"category_tags":51,"status":17},4487,"LLMs-from-scratch","rasbt\u002FLLMs-from-scratch","LLMs-from-scratch 是一个基于 PyTorch 的开源教育项目，旨在引导用户从零开始一步步构建一个类似 ChatGPT 的大型语言模型（LLM）。它不仅是同名技术著作的官方代码库，更提供了一套完整的实践方案，涵盖模型开发、预训练及微调的全过程。\n\n该项目主要解决了大模型领域“黑盒化”的学习痛点。许多开发者虽能调用现成模型，却难以深入理解其内部架构与训练机制。通过亲手编写每一行核心代码，用户能够透彻掌握 Transformer 架构、注意力机制等关键原理，从而真正理解大模型是如何“思考”的。此外，项目还包含了加载大型预训练权重进行微调的代码，帮助用户将理论知识延伸至实际应用。\n\nLLMs-from-scratch 特别适合希望深入底层原理的 AI 开发者、研究人员以及计算机专业的学生。对于不满足于仅使用 API，而是渴望探究模型构建细节的技术人员而言，这是极佳的学习资源。其独特的技术亮点在于“循序渐进”的教学设计：将复杂的系统工程拆解为清晰的步骤，配合详细的图表与示例，让构建一个虽小但功能完备的大模型变得触手可及。无论你是想夯实理论基础，还是为未来研发更大规模的模型做准备",90106,"2026-04-06T11:19:32",[35,15,13,14],{"id":53,"name":54,"github_repo":55,"description_zh":56,"stars":57,"difficulty_score":10,"last_commit_at":58,"category_tags":59,"status":17},4292,"Deep-Live-Cam","hacksider\u002FDeep-Live-Cam","Deep-Live-Cam 是一款专注于实时换脸与视频生成的开源工具，用户仅需一张静态照片，即可通过“一键操作”实现摄像头画面的即时变脸或制作深度伪造视频。它有效解决了传统换脸技术流程繁琐、对硬件配置要求极高以及难以实时预览的痛点，让高质量的数字内容创作变得触手可及。\n\n这款工具不仅适合开发者和技术研究人员探索算法边界，更因其极简的操作逻辑（仅需三步：选脸、选摄像头、启动），广泛适用于普通用户、内容创作者、设计师及直播主播。无论是为了动画角色定制、服装展示模特替换，还是制作趣味短视频和直播互动，Deep-Live-Cam 都能提供流畅的支持。\n\n其核心技术亮点在于强大的实时处理能力，支持口型遮罩（Mouth Mask）以保留使用者原始的嘴部动作，确保表情自然精准；同时具备“人脸映射”功能，可同时对画面中的多个主体应用不同面孔。此外，项目内置了严格的内容安全过滤机制，自动拦截涉及裸露、暴力等不当素材，并倡导用户在获得授权及明确标注的前提下合规使用，体现了技术发展与伦理责任的平衡。",88924,"2026-04-06T03:28:53",[14,15,13,60],"视频",{"id":62,"github_repo":63,"name":64,"description_en":65,"description_zh":66,"ai_summary_zh":66,"readme_en":67,"readme_zh":68,"quickstart_zh":69,"use_case_zh":70,"hero_image_url":71,"owner_login":72,"owner_name":73,"owner_avatar_url":74,"owner_bio":75,"owner_company":73,"owner_location":76,"owner_email":77,"owner_twitter":73,"owner_website":73,"owner_url":78,"languages":79,"stars":96,"forks":97,"last_commit_at":98,"license":99,"difficulty_score":32,"env_os":100,"env_gpu":100,"env_ram":100,"env_deps":101,"category_tags":108,"github_topics":110,"view_count":32,"oss_zip_url":73,"oss_zip_packed_at":73,"status":17,"created_at":120,"updated_at":121,"faqs":122,"releases":153},4454,"KarhouTam\u002FFL-bench","FL-bench","Benchmark of federated learning. Dedicated to the community. 🤗","FL-bench 是一个专为联邦学习社区打造的开源基准测试平台，旨在帮助开发者和研究人员轻松评估、对比各类联邦学习算法的性能。在联邦学习中，数据分布不均、设备异构性以及通信效率低下是常见挑战，不同算法在这些场景下的表现往往差异显著，却缺乏统一、透明的评测标准。FL-bench 通过集成多种经典与前沿方法——包括传统的 FedAvg、FedProx、SCAFFOLD，以及个性化联邦学习方案如 pFedSim、FedBN 等——为用户提供了一站式的实验环境，支持快速复现论文结果、验证新想法，并促进社区协作。\n\n该项目特别适合从事联邦学习研究的学者、算法工程师以及希望深入理解该领域的开发者使用。其核心亮点在于模块化设计与高度可扩展性：用户可灵活添加自定义数据集、模型结构或聚合策略，同时项目鼓励社区贡献，欢迎各类改进建议与代码提交。无论是初学者探索联邦学习基础，还是资深研究者推进前沿创新，FL-bench 都提供了一个友好、开放且功能丰富的实践平台，让“在联邦学习中实现精彩创意”变得触手可及。","\u003Cp align=\"center\">\n\u003Cimg src=\".github\u002Fimages\u002Flogo.svg\" alt=\"Image\"\u002F>\n\u003C\u002Fp>\n\u003C!-- \n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fblob\u002Fmaster\u002FLICENSE\">\n    \u003Cimg alt=\"GitHub License\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\"\u002F>\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues?q=is%3Aissue+is%3Aclosed\">\n    \u003Cimg alt=\"GitHub closed issues\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fissues-closed-raw\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fstargazers\">\n    \u003Cimg alt=\"GitHub Repo stars\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fforks\">\n    \u003Cimg alt=\"GitHub Repo forks\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n   -->\n\u003Ch4 align=\"center\">\u003Ci>\n\nBenchmarking Federated Learning Methods.\n\nRealizing Your Brilliant Ideas.\n\nHaving Fun with Federated Learning.\n\nFL-bench welcomes PR on everything that can make this project better.\n\n\u003C\u002Fi>\u003C\u002Fh4>\n\n\u003Cp align=\"center\">\n\u003Ca href=https:\u002F\u002Fzhuanlan.zhihu.com\u002Fp\u002F703576051>FL-bench 的简单介绍\u003C\u002Fa>\n\u003C\u002Fp>\n\n\n## Methods 🧬\n\n\n\n\u003C!-- \u003Cdetails> -->\n\u003Csummary>\u003Cb>Traditional FL Methods\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***FedAvg*** -- [Communication-Efficient Learning of Deep Networks from Decentralized Data](https:\u002F\u002Farxiv.org\u002Fabs\u002F1602.05629) (AISTATS'17)\n- ***FedAvgM*** -- [Measuring the Effects of Non-Identical Data Distribution for Federated Visual Classification](https:\u002F\u002Farxiv.org\u002Fabs\u002F1909.06335) (ArXiv'19)\n- ***FedProx*** -- [Federated Optimization in Heterogeneous Networks](https:\u002F\u002Farxiv.org\u002Fabs\u002F1812.06127) (MLSys'20)\n- ***SCAFFOLD*** -- [SCAFFOLD: Stochastic Controlled Averaging for Federated Learning](https:\u002F\u002Farxiv.org\u002Fabs\u002F1910.06378) (ICML'20)\n- ***MOON*** -- [Model-Contrastive Federated Learning](http:\u002F\u002Farxiv.org\u002Fabs\u002F2103.16257) (CVPR'21)\n- ***FedDyn*** -- [Federated Learning Based on Dynamic Regularization](http:\u002F\u002Farxiv.org\u002Fabs\u002F2111.04263) (ICLR'21)\n- ***FedLC*** -- [Federated Learning with Label Distribution Skew via Logits Calibration](http:\u002F\u002Farxiv.org\u002Fabs\u002F2209.00189) (ICML'22)\n- ***FedGen*** -- [Data-Free Knowledge Distillation for Heterogeneous Federated Learning](https:\u002F\u002Farxiv.org\u002Fabs\u002F2105.10056) (ICML'21)\n- ***CCVR*** -- [No Fear of Heterogeneity: Classifier Calibration for Federated Learning with Non-IID Data](https:\u002F\u002Farxiv.org\u002Fabs\u002F2106.05001) (NeurIPS'21)\n- ***FedOpt*** -- [Adaptive Federated Optimization](https:\u002F\u002Farxiv.org\u002Fabs\u002F2003.00295) (ICLR'21)\n- ***FedADMM*** -- [FedADMM: A robust federated deep learning framework with adaptivity to system heterogeneity](https:\u002F\u002Fieeexplore.ieee.org\u002Fabstract\u002Fdocument\u002F9835545) (ICDE'22)\n- ***Elastic Aggregation*** -- [Elastic Aggregation for Federated Optimization](https:\u002F\u002Fopenaccess.thecvf.com\u002Fcontent\u002FCVPR2023\u002Fhtml\u002FChen_Elastic_Aggregation_for_Federated_Optimization_CVPR_2023_paper.html) (CVPR'23)\n- ***FedFed*** -- [FedFed: Feature Distillation against Data Heterogeneity in Federated Learning](http:\u002F\u002Farxiv.org\u002Fabs\u002F2310.05077) (NeurIPS'23)\n\n\u003C!-- \u003C\u002Fdetails> -->\n\n\u003C!-- \u003Cdetails> -->\n\u003Csummary>\u003Cb>Personalized FL Methods\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***pFedSim (My Work⭐)*** -- [pFedSim: Similarity-Aware Model Aggregation Towards Personalized Federated Learning](https:\u002F\u002Farxiv.org\u002Fabs\u002F2305.15706) (ArXiv'23)\n- ***Local-Only*** -- Local training only (without communication).\n- ***FedMD*** -- [FedMD: Heterogenous Federated Learning via Model Distillation](http:\u002F\u002Farxiv.org\u002Fabs\u002F1910.03581) (NeurIPS'19)\n- ***APFL*** -- [Adaptive Personalized Federated Learning](http:\u002F\u002Farxiv.org\u002Fabs\u002F2003.13461) (ArXiv'20)\n- ***LG-FedAvg*** -- [Think Locally, Act Globally: Federated Learning with Local and Global Representations](https:\u002F\u002Farxiv.org\u002Fabs\u002F2001.01523) (ArXiv'20)\n- ***FedBN*** -- [FedBN: Federated Learning On Non-IID Features Via Local Batch Normalization](http:\u002F\u002Farxiv.org\u002Fabs\u002F2102.07623) (ICLR'21)\n- ***FedPer*** -- [Federated Learning with Personalization Layers](http:\u002F\u002Farxiv.org\u002Fabs\u002F1912.00818) (AISTATS'20)\n- ***FedRep*** -- [Exploiting Shared Representations for Personalized Federated Learning](http:\u002F\u002Farxiv.org\u002Fabs\u002F2102.07078) (ICML'21)\n- ***Per-FedAvg*** -- [Personalized Federated Learning with Theoretical Guarantees: A Model-Agnostic Meta-Learning Approach](https:\u002F\u002Fproceedings.neurips.cc\u002Fpaper\u002F2020\u002Fhash\u002F24389bfe4fe2eba8bf9a9203a44cdad-Abstract.html) (NeurIPS'20)\n- ***pFedMe*** -- [Personalized Federated Learning with Moreau Envelopes](http:\u002F\u002Farxiv.org\u002Fabs\u002F2006.08848) (NeurIPS'20)\n- ***FedEM*** -- [Federated Multi-Task Learning under a Mixture of Distributions](https:\u002F\u002Farxiv.org\u002Fabs\u002F2108.10252) (NIPS'21)\n- ***Ditto*** -- [Ditto: Fair and Robust Federated Learning Through Personalization](http:\u002F\u002Farxiv.org\u002Fabs\u002F2012.04221) (ICML'21)\n- ***pFedHN*** -- [Personalized Federated Learning using Hypernetworks](http:\u002F\u002Farxiv.org\u002Fabs\u002F2103.04628) (ICML'21)\n- ***pFedLA*** -- [Layer-Wised Model Aggregation for Personalized Federated Learning](https:\u002F\u002Fopenaccess.thecvf.com\u002Fcontent\u002FCVPR2022\u002Fhtml\u002FMa_Layer-Wised_Mdel_Aggregation_for_Personalized_Federated_Learning_CVPR_2022_paper.html) (CVPR'22)\n- ***CFL*** -- [Clustered Federated Learning: Model-Agnostic Distributed Multi-Task Optimization under Privacy Constraints](https:\u002F\u002Farxiv.org\u002Fabs\u002F1910.01991) (ArXiv'19)\n- ***FedFomo*** -- [Personalized Federated Learning with First Order Model Optimization](http:\u002F\u002Farxiv.org\u002Fabs\u002F2012.08565) (ICLR'21)\n- ***FedBabu*** -- [FedBabu: Towards Enhanced Representation for Federated Image Classification](https:\u002F\u002Farxiv.org\u002Fabs\u002F2106.06042) (ICLR'22)\n- ***FedAP*** -- [Personalized Federated Learning with Adaptive Batchnorm for Healthcare](https:\u002F\u002Farxiv.org\u002Fabs\u002F2112.00734) (IEEE'22)\n- ***kNN-Per*** -- [Personalized Federated Learning through Local Memorization](http:\u002F\u002Farxiv.org\u002Fabs\u002F2111.09360) (ICML'22)\n- ***MetaFed*** -- [MetaFed: Federated Learning among Federations with Cyclic Knowledge Distillation for Personalized Healthcare](http:\u002F\u002Farxiv.org\u002Fabs\u002F2206.08516) (IJCAI'22)\n- ***FedRoD*** -- [On Bridging Generic and Personalized Federated Learning for Image Classification](https:\u002F\u002Farxiv.org\u002Fabs\u002F2107.00778) (ICLR'22)\n- ***FedProto*** -- [FedProto: Federated prototype learning across heterogeneous clients](https:\u002F\u002Farxiv.org\u002Fabs\u002F2105.00243) (AAAI'22)\n- ***FedPAC*** -- [Personalized Federated Learning with Feature Alignment and Classifier Collaboration](https:\u002F\u002Farxiv.org\u002Fabs\u002F2306.11867v1) (ICLR'23)\n- ***FedALA*** -- [FedALA: Adaptive Local Aggregation for Personalized Federated Learning](https:\u002F\u002Farxiv.org\u002Fabs\u002F2212.01197) (AAAI'23)\n- ***PeFLL*** -- [PeFLL: Personalized Federated Learning by Learning to Learn](https:\u002F\u002Fopenreview.net\u002Fforum?id=MrYiwlDRQO) (ICLR'24)\n- ***FLUTE*** -- [Federated Representation Learning in the Under-Parameterized Regime](https:\u002F\u002Fopenreview.net\u002Fforum?id=LIQYhV45D4) (ICML'24)\n- ***FedAS*** -- [FedAS: Bridging Inconsistency in Personalized Federated Learning](https:\u002F\u002Fopenaccess.thecvf.com\u002Fcontent\u002FCVPR2024\u002Fhtml\u002FYang_FedAS_Bridging_Inconsistency_in_Personalized_Federated_Learning_CVPR_2024_paper.html) (CVPR'24)\n- ***pFedFDA*** -- [pFedFDA: Personalized Federated Learning via Feature Distribution Adaptation](http:\u002F\u002Farxiv.org\u002Fabs\u002F2411.00329) (NeurIPS 2024)\n- ***Floco*** -- [Federated Learning over Connected Modes](https:\u002F\u002Fopenreview.net\u002Fforum?id=JL2eMCfDW8) (NeurIPS'24)\n- ***FedAH*** -- [FedAH: Aggregated Head for Personalized Federated Learning](https:\u002F\u002Farxiv.org\u002Fabs\u002F2412.01295) (ArXiv'24)\n\u003C!-- \u003C\u002Fdetails> -->\n\n\n\u003C!-- \u003Cdetails> -->\n\u003Csummary>\u003Cb>FL Domain Generalization Methods\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***FedSR*** -- [FedSR: A Simple and Effective Domain Generalization Method for Federated Learning](https:\u002F\u002Fopenreview.net\u002Fforum?id=mrt90D00aQX) (NeurIPS'22)\n- ***ADCOL*** -- [Adversarial Collaborative Learning on Non-IID Features](https:\u002F\u002Fproceedings.mlr.press\u002Fv202\u002Fli23j.html) (ICML'23)\n- ***FedIIR*** -- [Out-of-Distribution Generalization of Federated Learning via Implicit Invariant Relationships](https:\u002F\u002Fopenreview.net\u002Fpdf?id=JC05k0E2EM) (ICML'23)\n\u003C!-- \u003C\u002Fdetails> -->\n\n\u003Csummary>\u003Cb>Differential Privacy FL Methods\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***DP-FedAvg*** -- [Learning Differentially Private Recurrent Language Models](https:\u002F\u002Farxiv.org\u002Fabs\u002F1710.06963) (ICLR 2018)\n\n## Environment Preparation 🧩\n\n### PyPI 🐍\n```sh\npip install -r .env\u002Frequirements.txt\n```\n\n## Easy Run 🏃‍♂️\n\nALL classes of methods are inherited from `FedAvgServer` and `FedAvgClient`. If you wanna figure out the entire workflow and detail of variable settings, go check [`src\u002Fserver\u002Ffedavg.py`](src\u002Fserver\u002Ffedavg.py) and [`src\u002Fclient\u002Ffedavg.py`](src\u002Fclient\u002Ffedavg.py).\n\n### Step 1. Generate FL Dataset\nPartition the MNIST according to Dir(0.1) for 100 clients\n```shell\npython generate_data.py -d mnist -a 0.1 -cn 100\n```\nAbout methods of generating federated dastaset, go check [`data\u002FREADME.md`](data\u002F#readme) for full details.\n\n\n### Step 2. Run Experiment\n\n```sh\npython main.py [--config-path, --config-name] [method=\u003CMETHOD_NAME> args...]\n```\n\n- `method`: The algorithm's name, e.g., `method=fedavg`. \n>   \\[!NOTE\\]\n>   `method` should be identical to the `.py` file name in `src\u002Fserver`.\n\n- `--config-path`: Relative path to the directory of the config file. Defaults to `config`.\n- `--config-name`: Name of `.yaml` config file (w\u002Fo the `.yaml` extension). Defaults to `defaults`, which points to `config\u002Fdefaults.yaml`.\n\nSuch as running FedAvg with all defaults. \n```sh\npython main.py method=fedavg\n```\nDefaults are set in both [`config\u002Fdefaults.yaml`](config\u002Fdefaults.yaml) and [`src\u002Futils\u002Fconstants.py`](src\u002Futils\u002Fconstants.py).\n\n### How To Customize FL method Arguments 🤖\n- By modifying config file.\n- By explicitly setting in CLI, e.g., `python main.py --config-name my_cfg.yaml method=fedprox fedprox.mu=0.01`.\n- By modifying the default value in `config\u002Fdefaults.yaml` or `get_hyperparams()` in `src\u002Fserver\u002F\u003Cmethod>.py`\n\n> \\[!NOTE\\]\n> For the same FL method argument, the priority of argument setting is **CLI > Config file > Default value**. \n> \n> For example, the default value of `fedprox.mu` is `1`, \n> ```python\n> # src\u002Fserver\u002Ffedprox.py\n> class FedProxServer(FedAvgServer):\n> \n>     @staticmethod\n>     def get_hyperparams(args_list=None) -> Namespace:\n>         parser = ArgumentParser()\n>         parser.add_argument(\"--mu\", type=float, default=1.0)\n>         return parser.parse_args(args_list)\n> \n> ```\n> and your `.yaml` config file has\n> ```yaml\n> # config\u002Fyour_config.yaml\n> ...\n> fedprox:\n>   mu: 0.01\n> ```\n> \n> ```shell\n> python main.py method=fedprox                                            # fedprox.mu = 1\n> python main.py --config-name your_config method=fedprox                  # fedprox.mu = 0.01\n> python main.py --config-name your_config method=fedprox fedprox.mu=0.001 # fedprox.mu = 0.001\n> ``` \n\n### Monitor 📈\nFL-bench supports `visdom` and `tensorboard`.\n\n#### Activate\n\n```yaml\n# your_config.yaml\ncommon:\n  ...\n  monitor: tensorboard # options: [null, visdom, tensorboard]\n```\n> \\[!NOTE\\]\n> You needs to launch `visdom` \u002F `tensorboard` server by yourself.\n\n#### Launch `visdom` \u002F `tensorboard` Server\n\n##### `visdom`\n1. Run `python -m visdom.server` on terminal.\n2. Go check `localhost:8097` on your browser.\n\n#### `tensorboard`\n1. Run `tensorboard --logdir=\u003Cyour_log_dir>` on terminal.\n2. Go check `localhost:6006` on your browser.\n\n## Parallel Training via `Ray` 🚀\nThis feature can **vastly improve your training efficiency**. At the same time, this feature is user-friendly and easy to use!!!\n### Activate (What You ONLY Need To Do)\n```yaml\n# your_config.yaml\nmode: parallel\nparallel:\n  num_workers: 2 # any positive integer that larger than 1\n  ...\n...\n```\n### Manually Create `Ray` Cluster (Optional)\nA `Ray` cluster would be created implicitly everytime you run experiment in parallel mode.\n\n> \\[!TIP\\]\n> You can create it manually by the command shown below to avoid creating and destroying cluster every time you run experiment.\n> ```shell\n> ray start --head [OPTIONS]\n> ```\n\n> \\[!NOTE\\]\n> You need to keep `num_cpus: null` and `num_gpus: null` in your config file for connecting to a existing `Ray` cluster.\n> \n> ```yaml\n> # your_config_file.yaml\n> # Connect to an existing Ray cluster in localhost.\n> mode: parallel\n> parallel:\n>   ...\n>   num_gpus: null\n>   num_cpus: null\n> ...\n> ```\n\n\n\n\n\n## Arguments 🔧\n\nFL-bench highly recommend through config file to customize your FL method and experiment settings. \n\nFL-bench offers a default config file [`config\u002Fdefaults.yaml`](config\u002Fdefaults.yaml) that contains all required arguments and corresponding comments.\n\nAll common arguments have their default value. Go check [`config\u002Fdefaults.yaml`](config\u002Fdefaults.yaml) or [`DEFAULTS`](src\u002Futils\u002Fconstants.py) in `src\u002Futils\u002Fconstants.py` for all argument defaults.\n\n> \\[!NOTE\\]\n> If your custom config file does not contain all required arguments, FL-bench will fill those missing arguments with their defaults that loaded from [`DEFAULTS`](src\u002Futils\u002Fconstants.py).\n\nAbout the default values of specific FL method arguments, go check corresponding `src\u002Fserver\u002F\u003Cmethod>.py` for the full details.\n\n> \\[!TIP\\]\n> FL-bench also supports CLI arguments for quick changings. Here are some examples:\n> ```\n> # Using config\u002Fdefaults.yaml but change the method to FedProx and set its mu to 0.1.\n> python main.py method=fedprox fedprox.mu=0.1\n> \n> # Change learning rate to 0.1.\n> python main.py optimizer.lr=0.1\n> \n> # Change batch size to 128.\n> python main.py common.batch_size=128\n> ```\n\n\n\n\n## Models 🤖\n\nThis benchmark supports bunch of models that common and integrated in Torchvision (check [here](src\u002Futils\u002Fmodels.py) for all):\n\n- ResNet family\n- EfficientNet family\n- DenseNet family\n- MobileNet family\n- LeNet5\n- ...\n\n\n> \\[!TIP\\]\n> You can define your own custom model by filling the `CustomModel` class in [`src\u002Futils\u002Fmodels.py`](src\u002Futils\u002Fmodels.py) and use it by defining `model: custom` in your `.yaml` config file.\n\n## Datasets and [Partition Strategies](data\u002FREADME.md) 🎨\n\nRegular Image Datasets\n\n- *MNIST* (1 x 28 x 28, 10 classes)\n\n- *CIFAR-10\u002F100* (3 x 32 x 32, 10\u002F100 classes)\n\n- *EMNIST* (1 x 28 x 28, 62 classes)\n\n- *FashionMNIST* (1 x 28 x 28, 10 classes)\n\n- [*Syhthetic Dataset*](https:\u002F\u002Farxiv.org\u002Fabs\u002F1812.06127)\n\n- [*FEMNIST*](https:\u002F\u002Fleaf.cmu.edu\u002F) (1 x 28 x 28, 62 classes)\n\n- [*CelebA*](https:\u002F\u002Fleaf.cmu.edu\u002F) (3 x 218 x 178, 2 classes)\n\n- [*SVHN*](http:\u002F\u002Fufldl.stanford.edu\u002Fhousenumbers\u002F) (3 x 32 x 32, 10 classes)\n\n- [*USPS*](https:\u002F\u002Fieeexplore.ieee.org\u002Fdocument\u002F291440) (1 x 16 x 16, 10 classes)\n\n- [*Tiny-ImageNet-200*](https:\u002F\u002Farxiv.org\u002Fpdf\u002F1707.08819.pdf) (3 x 64 x 64, 200 classes)\n\n- [*CINIC-10*](https:\u002F\u002Fdatashare.ed.ac.uk\u002Fhandle\u002F10283\u002F3192) (3 x 32 x 32, 10 classes)\n\nDomain Generalization Image Datasets\n\n- [*DomainNet*](http:\u002F\u002Fai.bu.edu\u002FDomainNet\u002F) (3 x ? x ?, 345 classes) \n  - Go check [`data\u002FREADME.md`](data#readme) for the full process guideline 🧾.\n  \nMedical Image Datasets\n\n- [*COVID-19*](https:\u002F\u002Fwww.researchgate.net\u002Fpublication\u002F344295900_Curated_Dataset_for_COVID-19_Posterior-Anterior_Chest_Radiography_Images_X-Rays) (3 x 244 x 224, 4 classes)\n\n- [*Organ-S\u002FA\u002FCMNIST*](https:\u002F\u002Fmedmnist.com\u002F) (1 x 28 x 28, 11 classes)\n\n## Customization Tips 💡\n\n### Implementing FL Method\n\nThe `package()` at server-side class is used for assembling all parameters server need to send to clients. Similarly, `package()` at client-side class is for parameters clients need to send back to server. You should always has `super().package()` in your override implementation. \n\n- Consider to inherit your method classes from [`FedAvgServer`](src\u002Fserver\u002Ffedavg.py) and [`FedAvgClient`](src\u002Fclient\u002Ffedavg.py) for maximum utilizing FL-bench's workflow.\n\n- You can also inherit your method classes from advanced methods, e.g., FedBN, FedProx, etc. Which will inherit all functions, variables and hyperparamter settings. If you do that, you need to careful design your method in order to avoid potential hyperparamters and workflow conflicts.\n```python\nclass YourServer(FedBNServer):\n  ...\n\nclass YourClient(FedBNClient):\n  ...\n```\n\n\n- For customizing your server-side process, consider to override the `package()` and `aggregate_client_updates()`.\n\n- For customizing your client-side training, consider to override the `fit()`, `set_parameters()` and `package()`.\n\nYou can find all details in [`FedAvgClient`](src\u002Fclient\u002Ffedavg.py) and [`FedAvgServer`](src\u002Fserver\u002Ffedavg.py), which are the bases of all implementations in FL-bench.\n\n### Integrating Dataset\n\n- Inherit your own dataset class from `BaseDataset` in [`data\u002Futils\u002Fdatasets.py`](data\u002Futils\u002Fdatasets.py) and add your class in dict `DATASETS`. Highly recommend to refer to the existing dataset classes for guidance.\n\n### Customizing Model\n\n- I offer the `CustomModel` class in [`src\u002Futils\u002Fmodels.py`](src\u002Futils\u002Fmodels.py) and you just need to define your model arch.\n- If you want to use your customized model within FL-bench's workflow, the `base` and `classifier` must be defined. (Tips: You can define one of them as `torch.nn.Identity()` for bypassing it.)\n\n## Citation 🧐\n\n```bibtex\n@software{Tan_FL-bench,\n  author = {Tan, Jiahao and Wang, Xinpeng},\n  license = {GPL-3.0},\n  title = {{FL-bench: A federated learning benchmark for solving image classification tasks}},\n  url = {https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench}\n}\n```\n\n```bibtex\n@misc{tan2023pfedsim,\n  title={pFedSim: Similarity-Aware Model Aggregation Towards Personalized Federated Learning}, \n  author={Jiahao Tan and Yipeng Zhou and Gang Liu and Jessie Hui Wang and Shui Yu},\n  year={2023},\n  eprint={2305.15706},\n  archivePrefix={arXiv},\n  primaryClass={cs.LG}\n}\n\n```\n","\u003Cp align=\"center\">\n\u003Cimg src=\".github\u002Fimages\u002Flogo.svg\" alt=\"Image\"\u002F>\n\u003C\u002Fp>\n\u003C!-- \n\u003Cp align=\"center\">\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fblob\u002Fmaster\u002FLICENSE\">\n    \u003Cimg alt=\"GitHub License\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Flicense\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\"\u002F>\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues?q=is%3Aissue+is%3Aclosed\">\n    \u003Cimg alt=\"GitHub closed issues\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fissues-closed-raw\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fstargazers\">\n    \u003Cimg alt=\"GitHub Repo stars\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fstars\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\">\n  \u003C\u002Fa>\n  \u003Ca href=\"https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fforks\">\n    \u003Cimg alt=\"GitHub Repo forks\" src=\"https:\u002F\u002Fimg.shields.io\u002Fgithub\u002Fforks\u002FKarhouTam\u002FFL-bench?style=for-the-badge&logo=github&color=8386e0\">\n  \u003C\u002Fa>\n\u003C\u002Fp>\n   -->\n\u003Ch4 align=\"center\">\u003Ci>\n\n联邦学习方法基准测试。\n\n实现您的精彩想法。\n\n与联邦学习一起玩得开心。\n\nFL-bench 欢迎一切能让该项目变得更好的 Pull Request。\n\n\u003C\u002Fi>\u003C\u002Fh4>\n\n\u003Cp align=\"center\">\n\u003Ca href=https:\u002F\u002Fzhuanlan.zhihu.com\u002Fp\u002F703576051>FL-bench 的简单介绍\u003C\u002Fa>\n\u003C\u002Fp>\n\n\n## 方法 🧬\n\n\n\n\u003C!-- \u003Cdetails> -->\n\u003Csummary>\u003Cb>传统联邦学习方法\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***FedAvg*** -- [来自去中心化数据的高效通信深度学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F1602.05629) (AISTATS'17)\n- ***FedAvgM*** -- [衡量非独立同分布数据对联邦视觉分类的影响](https:\u002F\u002Farxiv.org\u002Fabs\u002F1909.06335) (ArXiv'19)\n- ***FedProx*** -- [异构网络中的联邦优化](https:\u002F\u002Farxiv.org\u002Fabs\u002F1812.06127) (MLSys'20)\n- ***SCAFFOLD*** -- [SCAFFOLD：用于联邦学习的随机控制平均法](https:\u002F\u002Farxiv.org\u002Fabs\u002F1910.06378) (ICML'20)\n- ***MOON*** -- [基于模型对比的联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2103.16257) (CVPR'21)\n- ***FedDyn*** -- [基于动态正则化的联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2111.04263) (ICLR'21)\n- ***FedLC*** -- [通过 logits 校准处理标签分布偏斜的联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2209.00189) (ICML'22)\n- ***FedGen*** -- [无数据知识蒸馏，适用于异构联邦学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F2105.10056) (ICML'21)\n- ***CCVR*** -- [不怕异构性：针对非独立同分布数据的联邦学习分类器校准](https:\u002F\u002Farxiv.org\u002Fabs\u002F2106.05001) (NeurIPS'21)\n- ***FedOpt*** -- [自适应联邦优化](https:\u002F\u002Farxiv.org\u002Fabs\u002F2003.00295) (ICLR'21)\n- ***FedADMM*** -- [FedADMM：一种鲁棒的联邦深度学习框架，可适应系统异构性](https:\u002F\u002Fieeexplore.ieee.org\u002Fabstract\u002Fdocument\u002F9835545) (ICDE'22)\n- ***弹性聚合*** -- [用于联邦优化的弹性聚合](https:\u002F\u002Fopenaccess.thecvf.com\u002Fcontent\u002FCVPR2023\u002Fhtml\u002FChen_Elastic_Aggregation_for_Federated_Optimization_CVPR_2023_paper.html) (CVPR'23)\n- ***FedFed*** -- [FedFed：对抗联邦学习中数据异构性的特征蒸馏](http:\u002F\u002Farxiv.org\u002Fabs\u002F2310.05077) (NeurIPS'23)\n\n\u003C!-- \u003C\u002Fdetails> -->\n\n\u003C!-- \u003Cdetails> -->\n\u003Csummary>\u003Cb>个性化联邦学习方法\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***pFedSim (我的工作⭐)*** -- [pFedSim: 面向个性化联邦学习的相似性感知模型聚合](https:\u002F\u002Farxiv.org\u002Fabs\u002F2305.15706) (ArXiv'23)\n- ***仅本地*** -- 仅进行本地训练（不进行通信）。\n- ***FedMD*** -- [FedMD: 基于模型蒸馏的异构联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F1910.03581) (NeurIPS'19)\n- ***APFL*** -- [自适应个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2003.13461) (ArXiv'20)\n- ***LG-FedAvg*** -- [局部思考，全局行动：结合局部与全局表示的联邦学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F2001.01523) (ArXiv'20)\n- ***FedBN*** -- [FedBN: 基于本地批归一化的非独立同分布特征上的联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2102.07623) (ICLR'21)\n- ***FedPer*** -- [带有个性化层的联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F1912.00818) (AISTATS'20)\n- ***FedRep*** -- [利用共享表示实现个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2102.07078) (ICML'21)\n- ***Per-FedAvg*** -- [具有理论保证的个性化联邦学习：一种模型无关的元学习方法](https:\u002F\u002Fproceedings.neurips.cc\u002Fpaper\u002F2020\u002Fhash\u002F24389bfe4fe2eba8bf9a9203a44cdad-Abstract.html) (NeurIPS'20)\n- ***pFedMe*** -- [使用莫雷包络的个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2006.08848) (NeurIPS'20)\n- ***FedEM*** -- [混合分布下的联邦多任务学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F2108.10252) (NIPS'21)\n- ***Ditto*** -- [Ditto: 通过个性化实现公平且鲁棒的联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2012.04221) (ICML'21)\n- ***pFedHN*** -- [使用超网络的个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2103.04628) (ICML'21)\n- ***pFedLA*** -- [面向个性化联邦学习的逐层模型聚合](https:\u002F\u002Fopenaccess.thecvf.com\u002Fcontent\u002FCVPR2022\u002Fhtml\u002FMa_Layer-Wised_Mdel_Aggregation_for_Personalized_Federated_Learning_CVPR_2022_paper.html) (CVPR'22)\n- ***CFL*** -- [聚类联邦学习：在隐私约束下的模型无关分布式多任务优化](https:\u002F\u002Farxiv.org\u002Fabs\u002F1910.01991) (ArXiv'19)\n- ***FedFomo*** -- [基于一阶模型优化的个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2012.08565) (ICLR'21)\n- ***FedBabu*** -- [FedBabu: 向增强的联邦图像分类表示迈进](https:\u002F\u002Farxiv.org\u002Fabs\u002F2106.06042) (ICLR'22)\n- ***FedAP*** -- [用于医疗保健的自适应批归一化个性化联邦学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F2112.00734) (IEEE'22)\n- ***kNN-Per*** -- [通过本地记忆实现个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2111.09360) (ICML'22)\n- ***MetaFed*** -- [MetaFed: 联邦间的联邦学习，采用循环知识蒸馏以实现个性化医疗保健](http:\u002F\u002Farxiv.org\u002Fabs\u002F2206.08516) (IJCAI'22)\n- ***FedRoD*** -- [关于弥合通用与个性化联邦学习在图像分类中的差距](https:\u002F\u002Farxiv.org\u002Fabs\u002F2107.00778) (ICLR'22)\n- ***FedProto*** -- [FedProto: 跨异构客户端的联邦原型学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F2105.00243) (AAAI'22)\n- ***FedPAC*** -- [通过特征对齐和分类器协作实现个性化联邦学习](https:\u002F\u002Farxiv.org\u002Fabs\u002F2306.11867v1) (ICLR'23)\n- ***FedALA*** -- [FedALA: 个性化联邦学习中的自适应本地聚合](https:\u002F\u002Farxiv.org\u002Fabs\u002F2212.01197) (AAAI'23)\n- ***PeFLL*** -- [PeFLL: 通过“学会学习”实现个性化联邦学习](https:\u002F\u002Fopenreview.net\u002Fforum?id=MrYiwlDRQO) (ICLR'24)\n- ***FLUTE*** -- [欠参数化情形下的联邦表示学习](https:\u002F\u002Fopenreview.net\u002Fforum?id=LIQYhV45D4) (ICML'24)\n- ***FedAS*** -- [FedAS: 弥合个性化联邦学习中的不一致性](https:\u002F\u002Fopenaccess.thecvf.com\u002Fcontent\u002FCVPR2024\u002Fhtml\u002FYang_FedAS_Bridging_Inconsistency_in_Personalized_Federated_Learning_CVPR_2024_paper.html) (CVPR'24)\n- ***pFedFDA*** -- [pFedFDA: 通过特征分布自适应实现个性化联邦学习](http:\u002F\u002Farxiv.org\u002Fabs\u002F2411.00329) (NeurIPS 2024)\n- ***Floco*** -- [基于连接模式的联邦学习](https:\u002F\u002Fopenreview.net\u002Fforum?id=JL2eMCfDW8) (NeurIPS'24)\n- ***FedAH*** -- [FedAH: 个性化联邦学习的聚合头部](https:\u002F\u002Farxiv.org\u002Fabs\u002F2412.01295) (ArXiv'24)\n\u003C!-- \u003C\u002Fdetails> -->\n\n\n\u003C!-- \u003Cdetails> -->\n\u003Csummary>\u003Cb>联邦学习领域泛化方法\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***FedSR*** -- [FedSR: 一种简单有效的联邦学习领域泛化方法](https:\u002F\u002Fopenreview.net\u002Fforum?id=mrt90D00aQX) (NeurIPS'22)\n- ***ADCOL*** -- [非独立同分布特征上的对抗协同学习](https:\u002F\u002Fproceedings.mlr.press\u002Fv202\u002Fli23j.html) (ICML'23)\n- ***FedIIR*** -- [通过隐式不变关系实现联邦学习的分布外泛化](https:\u002F\u002Fopenreview.net\u002Fpdf?id=JC05k0E2EM) (ICML'23)\n\u003C!-- \u003C\u002Fdetails> -->\n\n\u003Csummary>\u003Cb>差分隐私联邦学习方法\u003C\u002Fb>\u003C\u002Fsummary>\n\n- ***DP-FedAvg*** -- [学习差分隐私的循环语言模型](https:\u002F\u002Farxiv.org\u002Fabs\u002F1710.06963) (ICLR 2018)\n\n\n\n## 环境准备 🧩\n\n### PyPI 🐍\n```sh\npip install -r .env\u002Frequirements.txt\n```\n\n## 轻松运行 🏃‍♂️\n\n所有方法类都继承自 `FedAvgServer` 和 `FedAvgClient`。如果你想了解整个流程及变量设置的细节，请查看 [`src\u002Fserver\u002Ffedavg.py`](src\u002Fserver\u002Ffedavg.py) 和 [`src\u002Fclient\u002Ffedavg.py`](src\u002Fclient\u002Ffedavg.py)。\n\n### 第一步：生成联邦学习数据集\n按照 Dir(0.1) 分配方式为 100 个客户端划分 MNIST 数据集\n```shell\npython generate_data.py -d mnist -a 0.1 -cn 100\n```\n有关联邦数据集生成方法的详细信息，请参阅 [`data\u002FREADME.md`](data\u002F#readme)。\n\n### 第二步：运行实验\n\n```sh\npython main.py [--config-path, --config-name] [method=\u003CMETHOD_NAME> args...]\n```\n\n- `method`: 算法名称，例如 `method=fedavg`。\n>   \\[!注意\\]\n>   `method` 应与 `src\u002Fserver` 中的 `.py` 文件名一致。\n\n- `--config-path`: 配置文件所在目录的相对路径。默认为 `config`。\n- `--config-name`: `.yaml` 配置文件的名称（不包括 `.yaml` 扩展名）。默认为 `defaults`，指向 `config\u002Fdefaults.yaml`。\n\n例如，使用所有默认设置运行 FedAvg：\n```sh\npython main.py method=fedavg\n```\n默认设置同时定义在 [`config\u002Fdefaults.yaml`](config\u002Fdefaults.yaml) 和 [`src\u002Futils\u002Fconstants.py`](src\u002Futils\u002Fconstants.py) 中。\n\n### 如何自定义联邦学习方法参数 🤖\n- 通过修改配置文件。\n- 在命令行中显式设置，例如：`python main.py --config-name my_cfg.yaml method=fedprox fedprox.mu=0.01`。\n- 修改 `config\u002Fdefaults.yaml` 中的默认值，或在 `src\u002Fserver\u002F\u003Cmethod>.py` 的 `get_hyperparams()` 函数中进行修改。\n\n> \\[!NOTE\\]\n> 对于同一个 FL 方法参数，参数设置的优先级是 **命令行 > 配置文件 > 默认值**。\n> \n> 例如，`fedprox.mu` 的默认值为 `1`：\n> ```python\n> # src\u002Fserver\u002Ffedprox.py\n> class FedProxServer(FedAvgServer):\n> \n>     @staticmethod\n>     def get_hyperparams(args_list=None) -> Namespace:\n>         parser = ArgumentParser()\n>         parser.add_argument(\"--mu\", type=float, default=1.0)\n>         return parser.parse_args(args_list)\n> \n> ```\n> 而你的 `.yaml` 配置文件中则有：\n> ```yaml\n> # config\u002Fyour_config.yaml\n> ...\n> fedprox:\n>   mu: 0.01\n> ```\n> \n> ```shell\n> python main.py method=fedprox                                            # fedprox.mu = 1\n> python main.py --config-name your_config method=fedprox                  # fedprox.mu = 0.01\n> python main.py --config-name your_config method=fedprox fedprox.mu=0.001 # fedprox.mu = 0.001\n> ``` \n\n### 监控 📈\nFL-bench 支持 `visdom` 和 `tensorboard`。\n\n#### 激活\n\n```yaml\n# your_config.yaml\ncommon:\n  ...\n  monitor: tensorboard # 选项：[null, visdom, tensorboard]\n```\n> \\[!NOTE\\]\n> 你需要自行启动 `visdom` \u002F `tensorboard` 服务器。\n\n#### 启动 `visdom` \u002F `tensorboard` 服务器\n\n##### `visdom`\n1. 在终端运行 `python -m visdom.server`。\n2. 打开浏览器访问 `localhost:8097`。\n\n#### `tensorboard`\n1. 在终端运行 `tensorboard --logdir=\u003Cyour_log_dir>`。\n2. 打开浏览器访问 `localhost:6006`。\n\n## 通过 `Ray` 进行并行训练 🚀\n该功能可以 **大幅提高你的训练效率**。同时，它也非常友好且易于使用！！！\n### 激活（你只需要做的）\n```yaml\n# your_config.yaml\nmode: parallel\nparallel:\n  num_workers: 2 # 任何大于 1 的正整数\n  ...\n...\n```\n### 手动创建 `Ray` 集群（可选）\n每次以并行模式运行实验时，都会隐式创建一个 `Ray` 集群。\n\n> \\[!TIP\\]\n> 你可以通过以下命令手动创建集群，以避免每次运行实验时都创建和销毁集群：\n> ```shell\n> ray start --head [OPTIONS]\n> ```\n\n> \\[!NOTE\\]\n> 为了连接到现有的 `Ray` 集群，你需要在配置文件中保持 `num_cpus: null` 和 `num_gpus: null`。\n> \n> ```yaml\n> # your_config_file.yaml\n> # 连接到本地已有的 Ray 集群。\n> mode: parallel\n> parallel:\n>   ...\n>   num_gpus: null\n>   num_cpus: null\n> ...\n> ```\n\n\n\n\n\n## 参数 🔧\n\nFL-bench 强烈推荐通过配置文件来定制你的 FL 方法和实验设置。\n\nFL-bench 提供了一个默认配置文件 [`config\u002Fdefaults.yaml`](config\u002Fdefaults.yaml)，其中包含了所有必需的参数及相应的注释。\n\n所有通用参数都有其默认值。请查看 [`config\u002Fdefaults.yaml`](config\u002Fdefaults.yaml) 或 `src\u002Futils\u002Fconstants.py` 中的 [`DEFAULTS`](src\u002Futils\u002Fconstants.py) 来了解所有参数的默认值。\n\n> \\[!NOTE\\]\n> 如果你的自定义配置文件中没有包含所有必需的参数，FL-bench 会用从 [`DEFAULTS`](src\u002Futils\u002Fconstants.py) 加载的默认值来填补缺失的参数。\n\n关于特定 FL 方法参数的默认值，请查看对应的 `src\u002Fserver\u002F\u003Cmethod>.py` 文件以获取详细信息。\n\n> \\[!TIP\\]\n> FL-bench 也支持通过命令行参数进行快速更改。以下是一些示例：\n> ```\n> # 使用 config\u002Fdefaults.yaml，但将方法改为 FedProx，并将其 mu 设置为 0.1。\n> python main.py method=fedprox fedprox.mu=0.1\n> \n> # 将学习率改为 0.1。\n> python main.py optimizer.lr=0.1\n> \n> # 将批量大小改为 128。\n> python main.py common.batch_size=128\n> ```\n\n\n\n\n## 模型 🤖\n\n该基准测试支持大量常见且集成在 Torchvision 中的模型（所有模型请参见 [`src\u002Futils\u002Fmodels.py`](src\u002Futils\u002Fmodels.py)）：\n\n- ResNet 系列\n- EfficientNet 系列\n- DenseNet 系列\n- MobileNet 系列\n- LeNet5\n- ...\n\n\n> \\[!TIP\\]\n> 你可以通过填充 [`src\u002Futils\u002Fmodels.py`](src\u002Futils\u002Fmodels.py) 中的 `CustomModel` 类来定义自己的自定义模型，并在你的 `.yaml` 配置文件中通过定义 `model: custom` 来使用它。\n\n## 数据集及 [划分策略](data\u002FREADME.md) 🎨\n\n常规图像数据集\n\n- *MNIST* (1 x 28 x 28，10 类)\n\n- *CIFAR-10\u002F100* (3 x 32 x 32，10\u002F100 类)\n\n- *EMNIST* (1 x 28 x 28，62 类)\n\n- *FashionMNIST* (1 x 28 x 28，10 类)\n\n- [*合成数据集*](https:\u002F\u002Farxiv.org\u002Fabs\u002F1812.06127)\n\n- [*FEMNIST*](https:\u002F\u002Fleaf.cmu.edu\u002F) (1 x 28 x 28，62 类)\n\n- [*CelebA*](https:\u002F\u002Fleaf.cmu.edu\u002F) (3 x 218 x 178，2 类)\n\n- [*SVHN*](http:\u002F\u002Fufldl.stanford.edu\u002Fhousenumbers\u002F) (3 x 32 x 32，10 类)\n\n- [*USPS*](https:\u002F\u002Fieeexplore.ieee.org\u002Fdocument\u002F291440) (1 x 16 x 16，10 类)\n\n- [*Tiny-ImageNet-200*](https:\u002F\u002Farxiv.org\u002Fpdf\u002F1707.08819.pdf) (3 x 64 x 64，200 类)\n\n- [*CINIC-10*](https:\u002F\u002Fdatashare.ed.ac.uk\u002Fhandle\u002F10283\u002F3192) (3 x 32 x 32，10 类)\n\n领域泛化图像数据集\n\n- [*DomainNet*](http:\u002F\u002Fai.bu.edu\u002FDomainNet\u002F) (3 x ? x ?，345 类)\n  - 请参阅 [`data\u002FREADME.md`](data#readme) 以获取完整的操作指南 🧾。\n  \n医学图像数据集\n\n- [*COVID-19*](https:\u002F\u002Fwww.researchgate.net\u002Fpublication\u002F344295900_Curated_Dataset_for_COVID-19_Posterior-Anterior_Chest_Radiography_Images_X-Rays) (3 x 244 x 224，4 类)\n\n- [*Organ-S\u002FA\u002FCMNIST*](https:\u002F\u002Fmedmnist.com\u002F) (1 x 28 x 28，11 类)\n\n## 自定义提示 💡\n\n### 实现 FL 方法\n\n服务器端类中的 `package()` 方法用于组装服务器需要发送给客户端的所有参数。同样，客户端端类中的 `package()` 方法用于封装客户端需要返回给服务器的参数。在重写实现时，务必保留 `super().package()`。\n\n- 建议让你的方法类继承自 [`FedAvgServer`](src\u002Fserver\u002Ffedavg.py) 和 [`FedAvgClient`](src\u002Fclient\u002Ffedavg.py)，以便最大限度地利用 FL-bench 的工作流程。\n\n- 你也可以让方法类继承自高级方法，例如 FedBN、FedProx 等，这样可以继承所有函数、变量和超参数设置。不过，这样做时需要仔细设计你的方法，以避免潜在的超参数和工作流程冲突。\n```python\nclass YourServer(FedBNServer):\n  ...\n\nclass YourClient(FedBNClient):\n  ...\n```\n\n\n- 若要自定义服务器端流程，可以考虑重写 `package()` 和 `aggregate_client_updates()` 方法。\n\n- 若要自定义客户端训练过程，可以考虑重写 `fit()`, `set_parameters()` 和 `package()` 方法。\n\n你可以在 [`FedAvgClient`](src\u002Fclient\u002Ffedavg.py) 和 [`FedAvgServer`](src\u002Fserver\u002Ffedavg.py) 中找到所有细节，它们是 FL-bench 中所有实现的基础。\n\n### 集成数据集\n\n- 请从 [`data\u002Futils\u002Fdatasets.py`](data\u002Futils\u002Fdatasets.py) 中的 `BaseDataset` 继承您自己的数据集类，并将其添加到字典 `DATASETS` 中。强烈建议参考现有的数据集类以获得指导。\n\n### 自定义模型\n\n- 我在 [`src\u002Futils\u002Fmodels.py`](src\u002Futils\u002Fmodels.py) 中提供了 `CustomModel` 类，您只需定义您的模型架构即可。\n- 如果您希望在 FL-bench 的工作流中使用自定义模型，则必须定义 `base` 和 `classifier`。（提示：您可以将其中任何一个定义为 `torch.nn.Identity()` 来绕过它。）\n\n## 引用 🧐\n\n```bibtex\n@software{Tan_FL-bench,\n  author = {Tan, Jiahao and Wang, Xinpeng},\n  license = {GPL-3.0},\n  title = {{FL-bench: 用于解决图像分类任务的联邦学习基准}},\n  url = {https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench}\n}\n```\n\n```bibtex\n@misc{tan2023pfedsim,\n  title={pFedSim：面向个性化联邦学习的相似性感知模型聚合}, \n  author={Jiahao Tan 和 Yipeng Zhou 和 Gang Liu 和 Jessie Hui Wang 和 Shui Yu},\n  year={2023},\n  eprint={2305.15706},\n  archivePrefix={arXiv},\n  primaryClass={cs.LG}\n}\n\n```","# FL-bench 快速上手指南\n\nFL-bench 是一个用于基准测试联邦学习（Federated Learning, FL）方法的开源框架，支持传统 FL、个性化 FL、域泛化及差分隐私等多种算法。\n\n## 环境准备\n\n### 系统要求\n- **操作系统**: Linux \u002F macOS \u002F Windows\n- **Python**: 建议 Python 3.8+\n- **依赖管理**: pip\n\n### 前置依赖\n本项目主要依赖 PyTorch 生态及相关科学计算库。请确保已安装基础开发环境。\n\n## 安装步骤\n\n1. 克隆仓库（如果尚未克隆）：\n   ```bash\n   git clone https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench.git\n   cd FL-bench\n   ```\n\n2. 安装 Python 依赖：\n   推荐使用国内镜像源加速安装（如清华源）：\n   ```bash\n   pip install -r .env\u002Frequirements.txt -i https:\u002F\u002Fpypi.tuna.tsinghua.edu.cn\u002Fsimple\n   ```\n\n## 基本使用\n\nFL-bench 的工作流主要分为两步：**生成数据集** 和 **运行实验**。所有算法均继承自 `FedAvgServer` 和 `FedAvgClient`。\n\n### 第一步：生成分布式数据集\n\n以将 MNIST 数据集按 Dirichlet 分布 (`alpha=0.1`) 划分给 100 个客户端为例：\n\n```shell\npython generate_data.py -d mnist -a 0.1 -cn 100\n```\n> **提示**: 更多数据生成策略（如 CIFAR-10, Shakespeare 等）请参考 `data\u002FREADME.md`。\n\n### 第二步：运行实验\n\n使用 `main.py` 启动训练。默认配置下运行 **FedAvg** 算法：\n\n```sh\npython main.py method=fedavg\n```\n\n#### 参数说明\n- `method`: 算法名称，必须与 `src\u002Fserver\u002F` 目录下的 `.py` 文件名一致（例如 `fedprox`, `scaffold`）。\n- `--config-name`: 指定配置文件名（不含 `.yaml` 后缀），默认为 `defaults`。\n- `--config-path`: 配置文件所在相对路径，默认为 `config`。\n\n#### 自定义超参数\n你可以通过命令行直接覆盖默认参数，优先级顺序为：**命令行 > 配置文件 > 代码默认值**。\n\n示例：运行 **FedProx** 并将正则化参数 `mu` 设为 `0.01`：\n```sh\npython main.py --config-name defaults method=fedprox fedprox.mu=0.01\n```\n\n### 可选：开启可视化监控\n\nFL-bench 支持 `tensorboard` 和 `visdom`。\n\n1. **修改配置** (`config\u002Fyour_config.yaml`)：\n   ```yaml\n   common:\n     monitor: tensorboard # 可选: null, visdom, tensorboard\n   ```\n\n2. **启动监控服务**（需在单独终端运行）：\n   - **TensorBoard**:\n     ```bash\n     tensorboard --logdir=\u003Cyour_log_dir>\n     ```\n     浏览器访问：`localhost:6006`\n   \n   - **Visdom**:\n     ```bash\n     python -m visdom.server\n     ```\n     浏览器访问：`localhost:8097`\n\n### 进阶：并行加速 (Ray)\n\n若需大幅提升训练效率，可启用 Ray 并行模式。只需在配置文件中设置：\n\n```yaml\nmode: parallel\nparallel:\n  num_workers: 2 # 设置为大于 1 的正整数\n```\n框架会自动处理 Ray 集群的创建与管理，无需额外操作。","某医疗 AI 研发团队正试图联合多家医院训练一个糖尿病视网膜病变检测模型，需在保护患者隐私的前提下验证不同联邦学习算法在数据异构场景下的有效性。\n\n### 没有 FL-bench 时\n- 团队需手动复现 FedAvg、FedProx、SCAFFOLD 等十几种经典算法，耗费数周编写重复的基础架构代码。\n- 缺乏统一的评估标准，不同算法在不同数据分布（Non-IID）下的性能对比困难，实验结果难以信服。\n- 调试个性化联邦学习策略（如 pFedSim 或 FedBN）时，因缺少基准参照，难以判断是算法缺陷还是实现错误。\n- 新成员上手门槛极高，需花费大量时间阅读原始论文并自行构建实验环境，严重拖慢研发进度。\n\n### 使用 FL-bench 后\n- 直接调用内置的 FedAvg、FedProx、MOON 等成熟算法模块，将算法验证周期从数周缩短至几天。\n- 利用预设的基准测试流程，一键生成各算法在标签分布倾斜或特征异构下的准确率与收敛曲线，对比直观清晰。\n- 基于现有的 Personalized FL 方法库快速修改参数，迅速定位模型性能瓶颈，高效迭代出适合医疗场景的定制化方案。\n- 团队成员通过统一接口协作，无需重复造轮子，可将精力集中于解决医疗数据特有的噪声与隐私挑战。\n\nFL-bench 通过提供标准化的联邦学习基准测试框架，让研发团队从繁琐的代码复现中解放出来，专注于算法创新与业务落地。","https:\u002F\u002Foss.gittoolsai.com\u002Fimages\u002FKarhouTam_FL-bench_507553f9.png","KarhouTam",null,"https:\u002F\u002Foss.gittoolsai.com\u002Favatars\u002FKarhouTam_66c6946b.png","Music 🎶\r\nCoding 👨‍💻\r\nWorkout 🏃‍♂️\r\nMemes 😺\r\nExploring 🌏","Solar System","karhou.tam@outlook.com","https:\u002F\u002Fgithub.com\u002FKarhouTam",[80,84,88,92],{"name":81,"color":82,"percentage":83},"Python","#3572A5",95.2,{"name":85,"color":86,"percentage":87},"Shell","#89e051",4.3,{"name":89,"color":90,"percentage":91},"Jupyter Notebook","#DA5B0B",0.4,{"name":93,"color":94,"percentage":95},"Dockerfile","#384d54",0.1,675,116,"2026-04-05T08:43:36","GPL-3.0","未说明",{"notes":102,"python":100,"dependencies":103},"1. 该项目是一个联邦学习基准测试工具，支持多种传统、个性化及差分隐私联邦学习算法。\n2. 运行前需通过 `pip install -r .env\u002Frequirements.txt` 安装依赖，但 README 未列出具体的库版本。\n3. 支持使用 Visdom 或 TensorBoard 进行实验监控，需用户手动启动相应服务。\n4. 支持通过 Ray 进行并行训练以提升效率，需在配置文件中设置 `mode: parallel` 并指定 worker 数量。\n5. 数据集生成（如 MNIST）和实验运行均通过命令行脚本执行，参数优先级为：命令行 > 配置文件 > 默认值。",[104,105,106,107],"requirements.txt 中定义的依赖 (具体列表未在 README 中展示)","visdom (可选，用于监控)","tensorboard (可选，用于监控)","ray (可选，用于并行训练)",[109,14],"插件",[111,112,113,114,115,116,117,118,119],"federated-learning","personalized-federated-learning","pytorch-implementation","federated-learning-framework","deep-learning","machine-learning","parallelism","ray","differential-privacy","2026-03-27T02:49:30.150509","2026-04-06T23:05:18.019248",[123,128,133,138,143,148],{"id":124,"question_zh":125,"answer_zh":126,"source_url":127},20262,"运行代码时遇到环境依赖或版本报错（如 'type' object is not subscriptable）怎么办？","建议使用 Poetry 来构建虚拟环境。使用 Poetry 可以确保安装的所有依赖版本与维护者的一致，从而避免版本冲突问题。具体使用方法请参考项目 README 中的教程。","https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues\u002F6",{"id":129,"question_zh":130,"answer_zh":131,"source_url":132},20263,"如何在 FL-bench 中设置 IID（独立同分布）数据环境？","需要将狄利克雷（Dirichlet）系数调整得非常大即可实现近似 IID 的数据分布。关于训练集和测试集比例的更改，通常不需要重新生成数据，可以直接在 data 目录下的 args.json 文件中进行修改。","https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues\u002F144",{"id":134,"question_zh":135,"answer_zh":136,"source_url":137},20264,"为什么训练日志中客户端准确率在上升，但最终全局测试结果为 0？测试集是如何划分的？","FL-bench 中的测试集数据是分布在各个客户端上的。系统支持两种测试模式：\n1. （默认模式）将模型发送到各客户端，在本地测试集上运行，结果传回服务器后，根据各客户端数据量大小进行加权平均得到最终值。\n2. 服务器聚合所有客户端测试集形成全局测试集，用公共模型跑完后得到结果。\n如果结果为 0，请确认是否正确应用了模式 1 的加权平均逻辑，或者检查是否正确开启了全局测试集模式。","https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues\u002F141",{"id":139,"question_zh":140,"answer_zh":141,"source_url":142},20265,"FedAvg 算法在包含 BatchNorm 的模型（如 ResNet18）上不收敛或表现 erratic 的原因是什么？","这是一个已知问题。在使用带有 BatchNorm 层的模型时，FedAvg 可能因为优化器状态未重置而导致性能不佳。对比实验显示，启用“优化器重置（optimizer resetting）”功能后，收敛曲线会变得更加稳定。此外，该问题可能与 FL-Bench 的 Dirichlet 数据划分器实现有关，建议参考 Flower 框架的实现作为基准进行对比调试。","https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues\u002F110",{"id":144,"question_zh":145,"answer_zh":146,"source_url":147},20266,"数据集加载后像素值范围异常（如 [-3, 1060]），未被正确归一化怎么办？","这是因为数据处理流程中缺少了一个将像素从 [0, 255] 转换到 [0, 1] 的步骤，直接导致了后续的 Normalize 变换失效。目前这是一个已知的 Bug，特别是在 CIFAR10\u002F100 等数据集上。预期行为是图像像素经过变换后应呈高斯分布。建议关注官方修复进度，或在本地代码中手动在 `transform.Normalize` 之前添加除以 255 的变换操作。","https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues\u002F88",{"id":149,"question_zh":150,"answer_zh":151,"source_url":152},20267,"FL-bench 中不同联邦学习算法的代码结构是怎样的？评估逻辑在哪里？","`FedAvgServer` 类相当于一个基类，FL-bench 中实现的所有算法都基于此类。大多数通用的方法（包括评估模型测试准确率、生成输出文件等）都实现在这个基类中。当然，某些特定的 FL 方法可能会有自己的 `test()` 实现，这种情况下会在它们各自的代码文件中重写该方法。","https:\u002F\u002Fgithub.com\u002FKarhouTam\u002FFL-bench\u002Fissues\u002F23",[]]