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

Make examples notebooks more prominent on page #6534

Open
Tracked by #7053
canyon289 opened this issue Feb 19, 2023 · 6 comments
Open
Tracked by #7053

Make examples notebooks more prominent on page #6534

canyon289 opened this issue Feb 19, 2023 · 6 comments

Comments

@canyon289
Copy link
Member

Issue with current documentation:

The notebooks page could use a an explainer that theres more notebooks available in the examples tab. Something like

These are the core notebooks, to see even more examples go to the examples page with a link to the examples page

https://www.pymc.io/projects/docs/en/stable/learn/core_notebooks/index.html
image

Idea or request for content:

No response

@canyon289 canyon289 added the docs label Feb 19, 2023
@canyon289 canyon289 changed the title DOC: <Please write a comprehensive title after the 'DOC: ' prefix> Make examples notebooks more prominent on page Feb 19, 2023
@Raj-Parekh24
Copy link
Contributor

Hey @canyon289 ,

I am Raj Parekh, recently completed my undergrads. I came across this organization through GSOC 2023 numfocus sub-projects. To get acquainted with project repos I want to work on some existing issues.

While exploring the issues I found this and want to work on this please guide me in solving this issue.

@canyon289
Copy link
Member Author

canyon289 commented Mar 4, 2023

Go for it! What I suggest is thinking of "what would be nice" to show on this page, then editing the ode to make it happen.

As the description says on the Learn tab it would be nice to also add a note saying the example tag has even more examples. This just requires a change to that page in the documentation.

I would setup an environment where you can build documentation locally, as described in the contributing docs. Then you can iterate locally before pushing to github

@Raj-Parekh24
Copy link
Contributor

Raj-Parekh24 commented Mar 5, 2023

Thank you for the direction,

I have followed the steps defined in contributor's guidelines and setup the repo.

During setup I faced the error during the installation of polyagamma, it throws an error of numpy module not found (although). It was already present.

I was able to fix this by explicitly installing it through conda forge and then installing packages present in requirements-dev.txt.

Based on my understanding the documentation is defined within .md and .rst files and the webpages are build using sphinx. So I tried to create html pages locally.

But when I try to build HTML web pages of the docs/source using:
sphinx-build -b html sourcedir outputdir
I got a series of errors like:-
Possible hints:

  • ModuleNotFoundError: No module named 'pymc.backends.NDArray.get_values'; 'pymc.backends.NDArray' is not a package
  • AttributeError: module 'pymc.backends.NDArray' has no attribute 'get_values'
  • ImportError:

Is my inference regarding the documentation web pages is right and am I going in the right direction?

@Raj-Parekh24
Copy link
Contributor

Hey I was able to solve the above errors:
Instead of pip install -e . to install existing package, I installed directly through git.

New error I am facing is:-
Handler <function process_generate_options at 0x0000027AFD75C400> for event 'builder-inited' threw an exception (exception: no module named pymc.sampling.jax)

@canyon289
Copy link
Member Author

Ah it looks like our install instructions are broken then. A better issue to fix than this one would be updating that so it works. It sounds like a mix of packages got installed and now things are the wrong versions.

My suggestions are

  1. Delete your current environment and start again
  2. Follow the instructions exactly and when you get a problem, open an issue ticket showing what the problem is.
  3. If you know the solution add that in the ticket too, if not ask in the ticket
  4. Once youve figured it out open a PR to update the docs so others don't run into the issue!

@Raj-Parekh24
Copy link
Contributor

Thanks for the suggestions @canyon289,

I also thought that installation instructions might be broken down. Confirmation from your side assured me.

I will follow the steps suggested by you and give updates within the current thread.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants