Skip to content

In the docs the library Turing.jl is often referred to as Turing. Is this misleading? #609

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

Open
AoifeHughes opened this issue Jun 3, 2025 · 4 comments
Assignees
Labels
help wanted Extra attention is needed question Further information is requested

Comments

@AoifeHughes
Copy link
Contributor

Some examples:

  • ## Using External Samplers on Turing Models
  • In this section, the current design of Turing's model "compiler" is described which enables Turing to perform various types of Bayesian inference without changing the model definition. The "compiler" is essentially just a macro that rewrites the user's model definition to a function that generates a `Model` struct that Julia's dispatch can operate on and that Julia's compiler can successfully do type inference on for efficient machine code generation.
  • Turing is created by <a href="http://mlg.eng.cam.ac.uk/hong/" target="_blank">Hong Ge</a>, and lovingly maintained by the <a href="https://github.com/TuringLang/Turing.jl/graphs/contributors" target="_blank">core team</a> of volunteers. <br>
    • This one is particularly confusing as it adds to the footer of the webpage: Turing is created by [Hong Ge](http://mlg.eng.cam.ac.uk/hong/), and lovingly maintained by the [core team](https://github.com/TuringLang/Turing.jl/graphs/contributors) of volunteers.
    • Which to me is confusing to read.

In summary, should we rename for consistency to only refer to the library as Turing.jl? If so, let me know and I'll make the updates.

@AoifeHughes AoifeHughes self-assigned this Jun 3, 2025
@AoifeHughes AoifeHughes added help wanted Extra attention is needed question Further information is requested labels Jun 3, 2025
@penelopeysm
Copy link
Member

It's kind of complicated. There are a couple of points:

  1. Turing.jl as a library is basically the top-level entry point to everything else in the TuringLang organisation, so sometimes Turing.jl really means 'just Turing.jl', and sometimes it really means the whole thing. The average user doesn't really need to know this, and I think when we (core devs) talk about it we can usually figure it out from the context. I do acknowledge this is kinda confusing.

  2. I think the more boring reason for this discrepancy, though, is that every Julia package is suffixed with .jl, so it's very common practice to just drop the suffix when it's clear from context what's being talked about.

Personally I wouldn't mind changing it (actually the footer does seem like it should be changed) but also I don't think it's super worth the time to comb through every usage 🙂

@shravanngoswamii
Copy link
Member

For the core devs, we can understand it by context but for official docs -- we should use Turing.jl and for footer, we may use TuringLang instead of Turing which is a more general term...

@shravanngoswamii
Copy link
Member

shravanngoswamii commented Jun 3, 2025

I will update the footer after the Turing Landing page PR is merged, as we will have to update footer and theme in both repos -- current footer is not even responsive.

@AoifeHughes
Copy link
Contributor Author

Hmm, dunno if it's useful, but I'd made a branch earlier which I just pushed: https://github.com/TuringLang/docs/tree/language-tweaks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

3 participants