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

Documentation and Tutorials #23

Merged
merged 8 commits into from
Jan 11, 2022
Merged

Documentation and Tutorials #23

merged 8 commits into from
Jan 11, 2022

Conversation

storopoli
Copy link
Member

This is the last PR to the initial release. Closes #2.

There is a nice quick start in the index.md along with all the docstring in the api.md.

The tutorials covered are "quick and dirty", we can improve more later.
They are:

  • Linear Regression: linear_regression.md
  • Logistic Regression: logistic_regression.md
  • Poisson Regression: poisson_regression.md
  • Negative Binomial Regression: negativebinomial_regression.md
  • Robust Regression: robust_regression.md
  • Hierarchical Models: hierarchical_models.md
  • Custom Priors: custom_priors.md

I also added a favicon.ico and turing logo to the documenter pages.

@storopoli storopoli added the documentation Improvements or additions to documentation label Jan 9, 2022
@storopoli storopoli added this to the 0.1.0 milestone Jan 9, 2022
@storopoli storopoli requested a review from rikhuijzer January 9, 2022 14:54
@storopoli storopoli self-assigned this Jan 9, 2022
@rikhuijzer
Copy link
Collaborator

The tutorials are very broken even though CI passes. There are two things we can do now:

  1. Ensure that the docs build fails first and then fix the docs.
  2. Switch to PlutoStaticHTML. I can set it up for you if you want. With PlutoStaticHTML, builds will fail if there is an error and we can provide readers with a notebook link which they can run locally.

@storopoli
Copy link
Member Author

I all up for PlutoStaticHTML.jl. Can you convert the PR to use it?

* Convert linear_regression tutorial to Pluto

* Got first two tutorials working

* Add files to gitignore

* Convert all tutorials except the last two

* Add last two tutorials

* Set timeout-minutes

* Apply suggestions from code review

Co-authored-by: Jose Storopoli <[email protected]>
@storopoli storopoli merged commit 7ead39d into main Jan 11, 2022
@storopoli storopoli deleted the docs-tutorials branch January 11, 2022 20:03
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.

Feature list for 0.1.0 release
2 participants