Skip to content

Converting all docs and tutorials to Quarto #441

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

Merged
merged 31 commits into from
May 23, 2024

Conversation

shravanngoswamii
Copy link
Member

No description provided.

@shravanngoswamii shravanngoswamii requested a review from yebai May 14, 2024 16:08
@yebai
Copy link
Member

yebai commented May 15, 2024

@shravanngoswamii It might be better to split this into several smaller PRs so we can review it. I suggest that we first convert jmd to qmd without changing any other files (e.g. do not change building scripts, or reorganise folder structure). This allows us to see the edits in the docs and tutorial texts. Then, we can have another PR update the building workflow, etc.

@shravanngoswamii
Copy link
Member Author

Ok, so you want to just replace jmd files with qmd without touching any other files!

One thing I would like to mention that each file will be renamed to index.qmd!

@yebai
Copy link
Member

yebai commented May 15, 2024

One thing I would like to mention that each file will be renamed to index.qmd!

If you add a commit to rename all files and then add all the changes, Git will correctly track them.

@shravanngoswamii
Copy link
Member Author

For now, they all will execute without any error because I put "eval=false" on the code blocks where I was getting errors and these are only a few documents from only tutorials section!

@shravanngoswamii shravanngoswamii requested review from yebai and removed request for yebai May 17, 2024 18:13
@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented May 19, 2024

Warnings in Using Turing section:

    • I do not know if this progress log is meant to be visible or not - Preview and Code Block

Warnings in the Tutorials section:

Errors in Tutorials section:

    • 08-multinomial-logistic-regression: These Code Blocks are not executing successfully: Code Blocks
      • Reason: in the current .jmd version, there is a parameter - fig_ext=".png" passed along with code block but there no feature like this in Quarto as far as I know!
      • MCMCChains related error.
    • 10-bayesian-differential-equations: I do not know if this is an issue or not because here after this Code Block, its like never-ending execution, I waited for more than an hour but the execution is not ending after this code block, for now, I put an eval: false on all code blocks after this!
      • lots of warning in the SDE part -- planed to separate the SDE part into a separate tutorial.

@yebai
Copy link
Member

yebai commented May 20, 2024

08-multinomial-logistic-regression: These Code Blocks are not executing successfully: Code Blocks
Reason: in the current .jmd version, there is a parameter - fig_ext=".png" passed along with code block but there no feature like this in Quarto as far as I know!

Can you find an alternative way to visualise the result?

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented May 20, 2024

Can you find an alternative way to visualise the result?

Ok, I will search for it!

@yebai
Copy link
Member

yebai commented May 20, 2024

10-bayesian-differential-equations: I do not know if this is an issue or not because here after this Code Block, its like never-ending execution, I waited for more than an hour but the execution is not ending after this code block, for now, I put an eval: false on all code blocks after this!

@devmotion, is this a known issue?

@shravanngoswamii
Copy link
Member Author

shravanngoswamii commented May 21, 2024

10-bayesian-differential-equations: I do not know if this is an issue or not because here after this Code Block, its like never-ending execution, I waited for more than an hour but the execution is not ending after this code block, for now, I put an eval: false on all code blocks after this!

@devmotion, is this a known issue?

I checked again, there is no error in that notebook because it did run fine in github actions, and in my laptop its like never ending!

it still have many warnings!

@JasonPekos
Copy link
Member

@yebai can you please have a look at

Ok, for Bayesian differential equations, I think this may not be a super simple fix. Here is an unresolved issue with the same problem: TuringLang/Turing.jl#1722 (actually this same broken tutorial is mentioned here). I think the first thing I'd try would be to swap out some of the truncated Normals to LogNormals, and maybe we won't get the same issues.

I don't actually know the logic behind the pretty tight truncation because I haven't done much SDEs — surely this isn't ideal? It's not surprising to me that there's weird gradient stuff happening here.

I will try fiddling around with the model to see if I can get something working 🧐 .

@yebai yebai changed the title docs for new website Converting all docs and tutorials to Quarto May 23, 2024
@yebai yebai merged commit 4468838 into TuringLang:master May 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants