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

Added "What is Aesara" section to documentation #970

Merged
merged 3 commits into from
Jun 4, 2022

Conversation

Mount-Blanc
Copy link
Contributor

Thank you for opening a PR!
Issue: #967

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.

@ricardoV94
Copy link
Contributor

ricardoV94 commented May 22, 2022

I am not sure we want this in the README. Right now the README is pretty succint and I think that's a good thing.

Perhaps under Aesara at a glance? https://aesara.readthedocs.io/en/latest/introduction.html

https://github.com/aesara-devs/aesara/blob/main/doc/introduction.rst

We already had a section on the difference between Aesara and Numpy

It might also require some small tuning to not sound out of place or repetitive in the context of the rest of the docs.

@twiecki twiecki requested a review from brandonwillard May 29, 2022 04:54
@brandonwillard brandonwillard added the documentation Improvements or additions to documentation label Jun 4, 2022
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.

Looks good, thanks!

@brandonwillard brandonwillard changed the title Added what is Aesara section to README Added "What is Aesara" section to documentation Jun 4, 2022
@brandonwillard brandonwillard merged commit 88f0299 into aesara-devs:main Jun 4, 2022
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.

3 participants