Skip to content

CHORE Add instructions for coding agents#3288

Open
BenjaminBossan wants to merge 2 commits into
huggingface:mainfrom
BenjaminBossan:chore-add-agent-instructions
Open

CHORE Add instructions for coding agents#3288
BenjaminBossan wants to merge 2 commits into
huggingface:mainfrom
BenjaminBossan:chore-add-agent-instructions

Conversation

@BenjaminBossan
Copy link
Copy Markdown
Member

I tried to keep it from getting too long. Inspired by the instructions in Transformers and Diffusers but adapted to PEFT.

I tried to keep it from getting too long. Inspired by the instructions
in Transformers and Diffusers but adapted to PEFT.
@HuggingFaceDocBuilderDev
Copy link
Copy Markdown

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@BenjaminBossan BenjaminBossan requested a review from githubnemo May 29, 2026 15:21
Comment thread .ai/AGENTS.md Outdated

### Testing

Check the install instructions to ensure that your environment has the necessary packages to run the tests. Typically, running `pip install ".e[test]"` should be enough. If you need specific packages, e.g. `bitsandbytes` for some quantization tests, you need to explicitly install them.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Check the install instructions to ensure that your environment has the necessary packages to run the tests. Typically, running `pip install ".e[test]"` should be enough. If you need specific packages, e.g. `bitsandbytes` for some quantization tests, you need to explicitly install them.
Check the install instructions to ensure that your environment has the necessary packages to run the tests. Typically, running `pip install ".[test]"` should be enough. If you need specific packages, e.g. `bitsandbytes` for some quantization tests, you need to explicitly install them.

Comment thread .ai/AGENTS.md
pytest tests/ -k ia3
```

Add further qualifiers if needed to reduce the amount of tests required to run. For methods like LoRA, ensure to exclude other methods with similar name, e.g.:
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add a remark that 0 tests run is a bad sign and that either the test selector is wrong or new tests need to be written

- install intruction fix
- remark on test selection
@BenjaminBossan BenjaminBossan requested a review from githubnemo June 2, 2026 13:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants