8000 Mkdocs math support + more and better docstrings + interfaces fix by loreloc · Pull Request #323 · april-tools/cirkit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Mkdocs math support + more and better docstrings + interfaces fix #323

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

Merged
merged 15 commits into from
Dec 12, 2024

Conversation

loreloc
Copy link
Member
@loreloc loreloc commented Dec 2, 2024

Add Katex support to mkdocs

Minor fix in the interfaces: use Mapping instead of dict to hint immutability.

Added more docstrings, and fixed previous ones in the following modules:

  • backend
    • torch
      • layers.{base,input,inner}
      • parameters.parameter
      • circuits
      • graph.modules
  • symbolic
    • functional
    • circuit
    • parameters

TODO: add docstrings for the very long list of classes in backend.torch.parameters.nodes

Closes #303 .

@loreloc loreloc added the documentation Improvements or additions to documentation label Dec 2, 2024
@loreloc loreloc self-assigned this Dec 2, 2024
@loreloc loreloc changed the title Mkdocs math support + more and better docstrings and interfaces Mkdocs math support + more and better docstrings + interfaces fix Dec 2, 2024
@loreloc loreloc added this to the cirkit 0.2.0 (murmur) milestone Dec 4, 2024
@loreloc loreloc merged commit 1338f7e into main Dec 12, 2024
1 of 2 checks passed
@loreloc loreloc deleted the more-docs branch December 12, 2024 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write docstrings for compiled circuits modules
1 participant
0