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

Doc Rebuild Needed? Broken link, fixed in .Rmd but not html #1004

Closed
katrinabrock opened this issue Jul 2, 2024 · 5 comments · Fixed by #1005 or #1006
Closed

Doc Rebuild Needed? Broken link, fixed in .Rmd but not html #1004

katrinabrock opened this issue Jul 2, 2024 · 5 comments · Fixed by #1005 or #1006
Labels
bug Something isn't working

Comments

@katrinabrock
Copy link

There is a broken link on this page: https://mc-stan.org/cmdstanr/articles/opencl.html

Seems to have been fixed by this commit: 2aff809

However, in corresponding HTML file still has the old/broken link.

<p>In this model, most of the computation will be handled by the <code>bernoulli_logit_glm_lpmf</code> function. Because this is a supported GPU function, it should be possible to accelerate it with OpenCL. Check <a href="http://mc-stan.org/math/opencl_support.html">here</a> for a list of functions with OpenCL support.</p>

@katrinabrock katrinabrock added the bug Something isn't working label Jul 2, 2024
@katrinabrock
Copy link
Author

Similarly...this commit 2709bb1 hasn't been deployed to the website so the current version's code doesn't work with recent versions.

@jgabry
Copy link
Member

jgabry commented Jul 2, 2024

Thanks, yeah I think we need to regenerate the html for the whole website! Will do that ASAP.

Similarly...this commit 2709bb1 hasn't been deployed to the website so the current version's code doesn't work with recent versions.

Strange, for me this one does actually appear to be updated on the website. At https://mc-stan.org/cmdstanr/articles/articles-online-only/opencl.html#compiling-a-model-with-opencl I see the new array syntax:

data {
  int<lower=1> k;
  int<lower=0> n;
  matrix[n, k] X;
  array[n] int y;
}

but regardless we definitely need to update the website. Thanks for pointing this out!

@jgabry jgabry linked a pull request Jul 2, 2024 that will close this issue
2 tasks
@jgabry
Copy link
Member

jgabry commented Jul 3, 2024

Should be updated now. Thanks again for letting us know.

@katrinabrock
Copy link
Author

@jgabry Thanks for looking into it!

The version I originally linked is different from the one you linked. The one I linked still exists and is out of date.

That HTML file seems like a relic from before this commit: 0b9b040

You can see the outdated html file still exits here: https://github.com/stan-dev/cmdstanr/blob/master/docs/articles/opencl.html

And the updated one here: https://github.com/stan-dev/cmdstanr/blob/master/docs/articles/articles-online-only/opencl.html

Seems like the doc rebuild does not remove html files that were generated from Rmd which no longer exist. Maybe there is a setting to change that? Or just identify and manually delete the html files? (Or better replace them with a link to the new version in case anyone bookmarked it.)

I'm not sure how I stumbled upon the outdated vignette. Google perhaps? It doesn't seem to be linked from other parts of the site.

@jgabry
Copy link
Member

jgabry commented Jul 3, 2024

Oh good point! I think a while back we changed the directory where the OpenCL vignette lives and forgot to remove the old version. So the doc rebuild does override the newer version of the OpenCL vignette (at https://github.com/stan-dev/cmdstanr/tree/master/docs/articles/articles-online-only) but there's still that older version in the other directory that we never got rid of. I will just delete it from the docs directory.

@jgabry jgabry linked a pull request Jul 3, 2024 that will close this issue
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
2 participants