Skip to content
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

Consolidate and expand Developer Documentation #1063

Open
Giuseppe5 opened this issue Oct 18, 2024 · 0 comments
Open

Consolidate and expand Developer Documentation #1063

Giuseppe5 opened this issue Oct 18, 2024 · 0 comments
Labels

Comments

@Giuseppe5
Copy link
Collaborator

Giuseppe5 commented Oct 18, 2024

Is your feature request related to a problem? Please describe.
It is not always easy to familiarize with the Brevitas codebase.
Among other things, because of dependency it is not immediately clear how the different element combine together and the debugger might not always help.
Similarly, we would need a better explanation of the hierarchical structure, the export structure, the working principles behind the implementation of our PTQ algorithms, and so on..

Describe the solution you'd like
We have some documents/notebooks explaining some architectural decisions of Brevitas, but it might be worth collating them together in a more coherent fashion, and going in more gradual steps to allow new developers a better understanding of the core aspects of Brevitas.

This doesn't have to be done all at once, and this issue is here mostly to capture the general concept of the task, to be further divided.

Thanks @rk119 for inspiring this

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant