adding AGENTS.md

[Borda]

What does this PR do?

some generated for agents?

Before submitting

• Was this discussed/agreed via a Github issue? (no need for typos and docs improvements)
• Did you read the contributor guideline, Pull Request section?
• Did you make sure to update the docs?
• Did you write any new necessary tests?

PR review

Anyone in the community is free to review the PR once the tests have passed.
If we didn't discuss your PR in Github issues there's a high chance it will not be merged.

Did you have fun?

Make sure you had fun coding 🙃

---

📚 Documentation preview 📚: https://torchmetrics--3232.org.readthedocs.build/en/3232/

[Copilot]

Pull Request Overview

This PR adds AGENTS.md documentation files across the TorchMetrics codebase to provide AI agents with structured guidelines for working with the project. The documentation covers installation, development environment setup, testing patterns, and contribution guidelines.

• Adds comprehensive project-level documentation in the root AGENTS.md file
• Creates domain-specific documentation for functional metrics, utilities, tests, and examples
• Establishes standardized patterns for AI agents working with TorchMetrics codebase

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
AGENTS.md	Root-level documentation covering installation, development setup, testing, and contribution guidelines
src/torchmetrics/functional/AGENTS.md	Guidelines for functional metrics implementation and usage patterns
src/torchmetrics/utilities/AGENTS.md	Documentation for plotting utilities and matplotlib integration
tests/AGENTS.md	Testing principles and patterns for metric validation
examples/AGENTS.md	Guidelines for running and formatting example scripts

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[SkafteNicki]

@Borda what is the purpose of having so many agents files?

[Borda]

what is the purpose of having so many agents files?

it supposed to help agents with navigation and correct usage, but maybe let's keep only these in the top folders?

[Borda]

• Complements Existing Documentation: While the repository already features a comprehensive README.md with installation, usage examples, and a brief contribution section encouraging community involvement via Discord, the proposed AGENTS.md files add specialized, directory-specific instructions tailored for AI agents, enhancing automation without overlapping or replacing the core human-focused guides.
• Boosts AI-Driven Contributions: These additions enable better integration with LLMs for tasks like code generation and testing in subdomains (e.g., functional metrics, utilities), addressing a gap in the current docs that primarily cater to manual developer workflows.
• Future-Proofs the Project: As AI tools become more prevalent in open-source development, incorporating agent-friendly documentation aligns with evolving practices, potentially increasing contribution quality and volume while keeping the overhead minimal with additive, focused files.
• Maintains Lightweight Structure: The PR introduces no changes to existing files, ensuring the main README and any contributing guidelines remain the primary entry points, with AGENTS.md serving as optional, advanced resources.

[Copilot]

Pull Request Overview

This PR adds AGENTS.md documentation files across multiple directories in the TorchMetrics project to provide guidance for AI agents working with the codebase. The files contain structured information about development practices, testing patterns, and usage guidelines.

• Introduces standardized documentation for AI agents across the project structure
• Provides domain-specific guidance for different parts of the codebase
• Establishes consistent patterns for testing, development, and contribution workflows

Reviewed Changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 3 comments.

Show a summary per file

File	Description
AGENTS.md	Root-level guide covering installation, development environment, and contribution guidelines
.devcontainer/AGENTS.md	Instructions for using the development container setup
docs/AGENTS.md	Documentation build process and style guidelines
examples/AGENTS.md	Usage patterns for example scripts and demonstrations
requirements/AGENTS.md	Package requirements and extras configuration
src/torchmetrics/functional/AGENTS.md	Guidelines for functional metrics implementation
src/torchmetrics/utilities/AGENTS.md	Plotting utilities documentation and usage patterns
tests/AGENTS.md	Testing principles and patterns for metric validation

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[Borda]

@lantiga, what do you think?