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

Refactor the documentation #1413

Merged
merged 21 commits into from
Feb 20, 2023
Merged

Refactor the documentation #1413

merged 21 commits into from
Feb 20, 2023

Conversation

rlouf
Copy link
Member

@rlouf rlouf commented Feb 7, 2023

  • Do we keep the d3viz stuff?
  • Do we keep the stuff about multicore support?
  • How to interpret the outputs of dprint
  • Reference for decorated functions (rewrites): See what Celery has done. There doesn't seem to be any easy way to do it.
  • Make sure the list of tensor operation is exhaustive
  • NumPy comparison
  • Scan diagram

Structure

What is Aesara?
Mission
Installing Aesara
Get help
Working with Aesara
    Building Aesara graphs
    Compiling
    Serializing
    Troubleshoot
Understanding Aesara
    Aesara graphs
    Compilation
    Rewrites
Extending Aesara

@rlouf rlouf added the documentation Improvements or additions to documentation label Feb 7, 2023
@rlouf rlouf force-pushed the refactor-docs branch 12 times, most recently from 9e9fd76 to 70b357a Compare February 7, 2023 22:35
Copy link
Member

@brandonwillard brandonwillard left a comment

Choose a reason for hiding this comment

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

Why the change from "Extending Aesara" to "Extend Aesara"? The former seems a little clearer to me regarding the subject matter of the content.

@rlouf rlouf force-pushed the refactor-docs branch 4 times, most recently from 8ef4516 to 37db046 Compare February 10, 2023 08:26
@codecov
Copy link

codecov bot commented Feb 10, 2023

Codecov Report

Merging #1413 (95849b0) into main (2f9a9e6) will decrease coverage by 0.01%.
The diff coverage is n/a.

❗ Current head 95849b0 differs from pull request most recent head ea6accc. Consider uploading reports for the commit ea6accc to get more accurate results

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1413      +/-   ##
==========================================
- Coverage   74.72%   74.72%   -0.01%     
==========================================
  Files         194      194              
  Lines       49877    49866      -11     
  Branches    10549    10549              
==========================================
- Hits        37273    37262      -11     
  Misses      10274    10274              
  Partials     2330     2330              
Impacted Files Coverage Δ
aesara/tensor/type.py 90.95% <ø> (ø)
aesara/tensor/var.py 87.82% <ø> (ø)
aesara/scalar/basic.py 79.02% <0.00%> (-0.02%) ⬇️
aesara/tensor/random/basic.py 99.03% <0.00%> (-0.02%) ⬇️
aesara/tensor/rewriting/math.py 85.95% <0.00%> (ø)

@dgerlanc
Copy link
Contributor

I'd vote "no" on d3viz.

Where is the multicore stuff?

@rlouf
Copy link
Member Author

rlouf commented Feb 18, 2023

Yeah I don't think we want to maintain the D3 viz module at all. The multi core stuff was just two paragraphs with not much information in it, I ended up removing it.

@rlouf rlouf marked this pull request as ready for review February 20, 2023 17:26
@rlouf rlouf merged commit 4c74650 into aesara-devs:main Feb 20, 2023
@rlouf rlouf deleted the refactor-docs branch February 20, 2023 17:27
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 enhancement New feature or request important
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants