Skip to content

AI glossary first submission #525

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
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kelbrown20
Copy link
Contributor

@kelbrown20 kelbrown20 commented May 13, 2025

This PR adds new AI terms to the style guide glossary

Copy link
Collaborator

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here's a first pass at a few bits of feedback!

*See also*:

[[Inference Server]]
==== image:images/yes.png[yes] Inference Server (noun)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should move above "inference serving" and "InferenceService" to be alphabetical

*See also*:

[[`InferenceService`]]
==== image:images/yes.png[yes] `InferenceService` (noun)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use markup in the headings. Just in the description below. Though to be honest, I don't think we've historically really put object names in as glossary entries. Is this always written this way, or would it sometimes be written generically as the "inference service"?

If yes, then I would put "inference service" as the glossary entry, and then say something in the description like, if you're talking about the actual object, then write it as InferenceService.

For a glossary entry in a similar situation, see "pod", "persistent volume claim", "service", etc.

Suggested change
==== image:images/yes.png[yes] `InferenceService` (noun)
==== image:images/yes.png[yes] InferenceService (noun)

*Use it*: yes

[.vale-ignore]
*Incorrect forms*: InferenceService, inference serving, inferenceservice
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Was this incorrect form supposed to be "inference service"?

(Also going back to my question about whether "inference service" could ever been used generically. It's fine if it's how you want to do it, but I also express my concerns about references to a certain concept always having to be in pascal case/monospace, since that's not a great reader experience)

Suggested change
*Incorrect forms*: InferenceService, inference serving, inferenceservice
*Incorrect forms*: InferenceService, inference serving, inference service

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want to suggest 'inference service' on its own. I only see it in the context of the object, but ill ask the RHOAI folks as well.

@bergerhoffer bergerhoffer added the Glossary entry Topics that add or modify glossary entries label May 15, 2025
@kelbrown20 kelbrown20 force-pushed the ai-glossary-updates-v1 branch from 57f011f to 428a59e Compare May 28, 2025 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Glossary entry Topics that add or modify glossary entries
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants