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

Minor improvements to index/install/intro docs #1443

Merged
merged 1 commit into from
Mar 8, 2023

Conversation

maresb
Copy link
Contributor

@maresb maresb commented Feb 19, 2023

Here are a few suggested cleanups for the docs. Please feel free to unilaterally revert any of these changes. I may make changes, but also feel free to merge now if you think it's an improvement.

I don't like that we duplicate install instructions between index.rst and install.rst. I think we should replace the "Install Aesara" section of index.rst with a link.

I was also wondering: is there some simple way to check which backend is in use?

Thank you for opening a PR!

Here are a few important guidelines and requirements to check before your PR can be merged:

  • There is an informative high-level description of the changes.
  • The description and/or commit message(s) references the relevant GitHub issue(s).
  • pre-commit is installed and set up.
  • The commit messages follow these guidelines.
  • The commits correspond to relevant logical changes, and there are no commits that fix changes introduced by other commits in the same branch/BR.
  • There are tests covering the changes introduced in the PR.

Don't worry, your PR doesn't need to be in perfect order to submit it. As development progresses and/or reviewers request changes, you can always rewrite the history of your feature/PR branches.

If your PR is an ongoing effort and you would like to involve us in the process, simply make it a draft PR.

@rlouf
Copy link
Member

rlouf commented Feb 27, 2023

The doc has changed substantially since #1413 was merged, so you'll unfortunately need to solve the merge conflicts. The changes look good.

@maresb
Copy link
Contributor Author

maresb commented Feb 27, 2023

Ah, ok, no worries. I'll take care of it once I find the time.

@maresb
Copy link
Contributor Author

maresb commented Feb 27, 2023

Is there a simple way to check which backend Aesara is using?

@rlouf
Copy link
Member

rlouf commented Feb 27, 2023

Is there a simple way to check which backend Aesara is using?

I might have misunderstood your question, but Aesara is always using C unless you specify aesara.function(...., mode="JAX") or aesara.function(...., mode="NUMBA").

@brandonwillard brandonwillard added the documentation Improvements or additions to documentation label Feb 27, 2023
@brandonwillard brandonwillard added the enhancement New feature or request label Feb 27, 2023
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants