-
Notifications
You must be signed in to change notification settings - Fork 74
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
base: main
Are you sure you want to change the base?
AI glossary first submission #525
Conversation
There was a problem hiding this 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!
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
*See also*: | ||
|
||
[[Inference Server]] | ||
==== image:images/yes.png[yes] Inference Server (noun) |
There was a problem hiding this comment.
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) |
There was a problem hiding this comment.
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.
==== image:images/yes.png[yes] `InferenceService` (noun) | |
==== image:images/yes.png[yes] InferenceService (noun) |
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
*Use it*: yes | ||
|
||
[.vale-ignore] | ||
*Incorrect forms*: InferenceService, inference serving, inferenceservice |
There was a problem hiding this comment.
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)
*Incorrect forms*: InferenceService, inference serving, inferenceservice | |
*Incorrect forms*: InferenceService, inference serving, inference service |
There was a problem hiding this comment.
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.
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
supplementary_style_guide/glossary_terms_conventions/general_conventions/i.adoc
Outdated
Show resolved
Hide resolved
57f011f
to
428a59e
Compare
This PR adds new AI terms to the style guide glossary