Skip to content

Tweaks to inspect accelerator tutorial - #53

Merged
GamelinAl merged 2 commits into
docs/intro-structure-configurationfrom
docs/inspect-accelerator
Oct 5, 2026
Merged

GamelinAl merged 2 commits into
docs/intro-structure-configurationfrom
docs/inspect-accelerator

Conversation

@TeresiaOlsson

@TeresiaOlsson TeresiaOlsson commented Oct 2, 2026 •

Copy link
Copy Markdown
Member

I only made some tiny changes. The rest looked better than before to me.

But reading this tutorial made me confused about the responsibility of the yellow pages vs the responsibility of the element holders. You can also get elements through the yellow pages so there is even more APIs available for the users?

I think this is confusing rather than helpful:

qfortune = yp.QForTune
print(qfortune.keys())
print(qfortune["design"] is accelerator.design.magnets.get("QForTune"))

Having several ways to achieve the same thing I think makes it difficult for new users. Fewer options are easier to learn. So either maybe we should hide this functionality from the tutorials or we should try to align the APIs in a way that makes it easier to understand the two options? For example if the tutorial had said:

accelerator["design"]["magnets"]["QForTune"] is accelerator.design.magnets.get("QForTune")

where the first is the API for the yellow pages and the second for the element holder it would have made sense to me. But at the moment I don't understand how the user from looking at the yellow pages will understand that there is also the option to do accelerator.design.magnets.get("QForTune") since it doesn't list anything called magnets. But aligning the APIs for these two is perhaps part of the work with the modifications to the element holder?

@GamelinAl

Copy link
Copy Markdown
Member

I agree with you, this tutorial is not very good anyway. I'll make a better one once the ElementHolder PR has been merged. Let's merge this for now.

@GamelinAl
GamelinAl merged commit c7f744e into docs/intro-structure-configuration Oct 5, 2026
2 checks passed
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.

2 participants