# Welcome

FedPruning is a comprehensive library and benchmark designed for efficient federated pruning. This user guide includes the following sections:

* **Installation**: Provides recommendations for using an IDE and basic tools, along with the prerequisites for running FedPruning.
* **Getting Started**: Uses the classical FedAVG as an example to demonstrate key components such as the data loader, server manager, client manager, and model trainer.
* **Methods**: Helps you explore the all pruning methods in detail, enabling you to write custom methods and contribute to the project.

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Installation</strong></td><td>Build the Environments</td><td></td><td></td><td><a href="installation/ide-and-tools-setting">ide-and-tools-setting</a></td></tr><tr><td><strong>Getting Started</strong></td><td>Quick Start</td><td></td><td></td><td><a href="getting-started/quickstart">quickstart</a></td></tr><tr><td><strong>Methods</strong></td><td>Explore the methods</td><td></td><td></td><td><a href="methods/overview">overview</a></td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://honghuangs-organization.gitbook.io/fedpruning-documents/readme.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.