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

Jump to bottom

Documentation #1051

Merged
merged 123 commits into from
Oct 21, 2022
Merged

Documentation #1051

merged 123 commits into from
Oct 21, 2022

Conversation

tbennun
Copy link
Collaborator

@tbennun tbennun commented Jul 11, 2022 •
edited
Loading

This PR adds extensive documentation to the DaCe readthedocs page.

  • Fix docstring formatting
  • Update CONTRIBUTING.md
  • Quick-start
  • Transformation / Pass internals
  • Installation
  • Configuration
    • Auto-generate configuration entry documentation
  • VSCode
    • Extension + SDFG editor
    • Analysis and Transformations
  • Command-line utilities
  • Properties and Serialization
  • Debugging
  • DaCe Python
  • SDFG IR
    • common pitfalls: looping over nodes() may not be in topological order
  • Integration of SDFGs in existing programs
  • Optimizing programs
    • Profiling/instrumentation
    • BLAS
    • GPU best practices
    • FPGA best practices
  • Module structure
  • Python frontend
    • Features / support
  • Code generation
    • Debugging Code Generators
    • FPGA Code Generation
    • C++ Runtime (include folder structure)
  • Extending DaCe
    • New transformations
  • Glossary
  • General development errors

After docs are done:

  • Reduce README size and point to docs

Non-documentation related changes:

  • Use config type in cmake
  • Add is_library_installed testing API

Postponed to next version:

  • To review:

    • Python frontend features / support
    • FPGA optimization best practices
    • FPGA code generation

  • Python frontend preprocessing

  • Optimizing SDFGs with the SDFG API

  • GPU optimization best practices (finalize)

  • FPGA optimization best practices (finalize)

  • Profiling and instrumentation (finalize)

  • Extending DaCe

    • Working with symbolic expressions
    • New library nodes
    • New frontend
    • DSLs and SDFGConvertible
    • New Backends
    • Writing your own instrumentation provider

tbennun and others added 29 commits July 12, 2022 00:40
@tbennun
Documentation outline
c77467a
@tbennun
Minor doc updates
d8c20b1
@tbennun
Groundwork for automatic config schema generator
a36b64e
@tbennun
Autogenerate docs from configuration schema
ed01338
@tbennun
Minor modification
4cf609e
@tbennun
Minor corrections
611fc44
@tbennun
Add type hint analysis to documentation
09d2329
@tbennun
Format docstrings
55e7963
@tbennun
Quickstart
3834870
@tbennun
Clean documentation warnings
187a770
@tbennun
Avoid importing submodule if not necessary
411e621
@tbennun
Update instructions of how to contribute docstrings
9797046
@tbennun
Merge branch 'master' into docs
d91d88b
@phschaad
VSCode doc
597314e
@phschaad
Merge branch 'docs' of github.com:spcl/dace into docs
3ba0740
@tbennun
Doc updates
8af9000
@phschaad
Improve VSCode documentation with inline images for buttons
0538d42
@tbennun
Merge branch 'docs' of github.com:spcl/dace into docs
011ab73
@tbennun
Merge remote-tracking branch 'origin/master' into docs
d229ea7 
# Conflicts:
#	dace/transformation/passes/dead_state_elimination.py
@phschaad
Improve VSCode docs
ef27eb8
@phschaad
Add vscode optimization doc
dff0f55
@phschaad
Document CLI tools
82d9dda
@tbennun
New README, move FAQ out of SDFG
ebc2731
@tbennun
Minor fix
3d2a953
@phschaad
Add localview docs
039cacf
@tbennun
Update general-ci.yml
4d34958
@tbennun
Update fpga-ci.yml
f7e3c18
@tbennun
Update gpu-ci.yml
fd40144
@tbennun
Update heterogeneous-ci.yml
1949fae
@tbennun tbennun added the no-ci Do not run any CI or actions for this PR label Jul 13, 2022
TizianoDeMatteis and others added 24 commits September 21, 2022 10:43
@TizianoDeMatteis
Merge branch 'master' into docs
ff3acca
@TizianoDeMatteis
Merge branch 'master' into docs
df7e0c0
@TizianoDeMatteis
Missing info in config schema
596a633
@TizianoDeMatteis
Started FPGA best practices
38144e5
@TizianoDeMatteis
Merge branch 'master' into docs
ff468ce
@TizianoDeMatteis
FPGA doc: memory hiearchy
ffe177d
@TizianoDeMatteis
FPGA best practices
517a4ab
@tbennun
Merge branch 'master' into docs
3f839bb
@tbennun
Minor corrections
9dae4d3
@TizianoDeMatteis
Merge, resolve conflicts on validation.py
283f116
@TizianoDeMatteis
Address FPGA best practice review comments (first round)
a7bb115
@tbennun
Merge branch 'master' into docs
46d95a2 
# Conflicts:
#	dace/codegen/compiled_sdfg.py
#	dace/frontend/python/preprocessing.py
#	dace/frontend/python/replacements.py
@tbennun
update
8aefafc
@tbennun
minor work
73d74d8
@tbennun
Move low priority doc pages to second version
92d0c9c
@tbennun
test
cd1d02d
@tbennun
frontend and extending
061ec6a
@tbennun
readme update
02e985f
@tbennun
all WIP docs
88cbc10
@tbennun
codegen and other things
29639de
@tbennun
optimization, profiling, and instrumentation
4c87988
@tbennun
Integration
b236c81
@tbennun
GPU optimization
1e51353
@tbennun
minor correction
9162f56
@tbennun tbennun removed the no-ci Do not run any CI or actions for this PR label Oct 21, 2022
@tbennun tbennun marked this pull request as ready for review October 21, 2022 18:24
@tbennun tbennun merged commit e6cabbb into master Oct 21, 2022
@tbennun tbennun deleted the docs branch October 21, 2022 23:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@tbennun @orausch @phschaad @alexnick83 @TizianoDeMatteis