-
Notifications
You must be signed in to change notification settings - Fork 20
Add copilot instructions #1000
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Add copilot instructions #1000
Conversation
|
@copilot could you check the instructions added in this PR and see if you would be able to work nicely with them |
pfebrer
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I have just two comments
.github/copilot-instructions.md
Outdated
|
|
||
| When reviewing code, verify: | ||
|
|
||
| - Imports are absolute, not relative |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not true in general, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes indeed. We rather use relative imports.
.github/copilot-instructions.md
Outdated
| - `documentation.py`: Defines `ModelHypers` and `TrainerHypers` Pydantic classes | ||
| - `model.py`: Implements `ModelInterface` from `utils/abc.py` | ||
| - `trainer.py`: Implements `TrainerInterface` from `utils/abc.py` | ||
| - **YAML validation**: Use `OmegaConf` → Pydantic validators in `utils/pydantic.py` → `check_architecture_options()` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This sentence is not very clear imo, but maybe it works
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed it.
|
Thanks we should also add line width as we often have linting issues |
|
But this one should only be for comments or multi-line strings, which |
dd6aafc to
97fc1bd
Compare
97fc1bd to
f35927b
Compare
As discussed in the slack.
It make sense to also add hacks and tricks that we sometimes do to this file. @frostedoyster and @pfebrer if you have ideas just add them.
📚 Documentation preview 📚: https://metatrain--1000.org.readthedocs.build/en/1000/