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.

Sign up for GitHub

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

Update README.md for v1.0.0 #1100

Merged
merged 33 commits into from
Dec 9, 2024
Merged

Update README.md for v1.0.0 #1100

Changes from 1 commit
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
cfad81f
Fix wrong note in README.md
bo3z Oct 29, 2024
d422659
Merge branch 'main' into update-readme
jmitrevs Nov 5, 2024
fabcf8c
update the project status
jmitrevs Nov 5, 2024
b844acf
restructure of existing documentation
jmitrevs Nov 5, 2024
88e84f3
add an internal layers section, and auto precision
jmitrevs Nov 5, 2024
6abc8ad
pre-commit fixes
jmitrevs Nov 5, 2024
7570c11
Merge remote-tracking branch 'upstream/main' into update-docs
vloncar Nov 26, 2024
09bbefb
Typo fixes
vloncar Nov 26, 2024
42cb368
Add video tutorial link
bo3z Dec 3, 2024
26f4eb2
Merge branch 'main' into update-readme
jmitrevs Dec 4, 2024
fedf790
respond to some review comments and update some descriptions
jmitrevs Dec 4, 2024
f28f364
fix documentation of channels_last conversion for pytorch
JanFSchulte Dec 5, 2024
e55b29c
slightly expand discussion of channels_last in pytorch
JanFSchulte Dec 5, 2024
99e3be0
update requirements
jmduarte Dec 5, 2024
96b530f
add pointwise documentation
jmduarte Dec 5, 2024
a7b6f79
update pointwise description
jmduarte Dec 5, 2024
135eaa2
Merge remote-tracking branch 'upstream/main' into update-readme
vloncar Dec 6, 2024
6af7fef
Add FAQ to docs and readme
vloncar Dec 6, 2024
eac61dd
Nicer link to the tutorial
vloncar Dec 6, 2024
c65e915
add doc strings to pytorch-specific padding calculation functions
JanFSchulte Dec 6, 2024
7cf4134
Merge branch 'update-readme' of https://github.com/fastmachinelearnin…
JanFSchulte Dec 6, 2024
4fc1ea9
clarify default for channels last conversion in pytorch
JanFSchulte Dec 6, 2024
548c462
Restructure documentation
vloncar Dec 6, 2024
4da52a4
bump version to 1.0.0
jmduarte Dec 6, 2024
6959c71
remove obsolete file references
jmitrevs Dec 6, 2024
47d7435
add a touch of text on the backends
jmitrevs Dec 6, 2024
05f8a45
expand pytorch frontend documentation
JanFSchulte Dec 8, 2024
6f971eb
Merge branch 'main' into update-readme
JanFSchulte Dec 9, 2024
536c069
[pre-commit.ci] auto fixes from pre-commit hooks
pre-commit-ci[bot] Dec 9, 2024
d9d09e0
typos in pytorch frontend documentation
JanFSchulte Dec 9, 2024
16c4055
Merge branch 'update-readme' of https://github.com/fastmachinelearnin…
JanFSchulte Dec 9, 2024
e69a392
improve description of brevtias -> QONNX -> hlsm4l workflow
JanFSchulte Dec 9, 2024
896951a
Add docs on BramFactor
vloncar Dec 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@ If you have any questions, comments, or ideas regarding hls4ml or just want to s

# Documentation & Tutorial

For more information visit the webpage: [https://fastmachinelearning.org/hls4ml/](https://fastmachinelearning.org/hls4ml/)
For more information visit the webpage: [https://fastmachinelearning.org/hls4ml/](https://fastmachinelearning.org/hls4ml/).

For introductory material on FPGAs, HLS and ML inferences using hls4ml, check out the [video](https://www.youtube.com/watch?v=2y3GNY4tf7A&ab_channel=SystemsGroupatETHZ%C3%BCrich).
Copy link
Contributor

Choose a reason for hiding this comment

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

Does it make sense to also add this to the documentation, not just the readme?


Detailed tutorials on how to use `hls4ml`'s various functionalities can be found [here](https://github.com/hls-fpga-machine-learning/hls4ml-tutorial).

Expand Down
Loading