-
Notifications
You must be signed in to change notification settings - Fork 21
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
glossary: add expanded definition for 'fair-share' #261
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.
Seems good to me! But you mentioned the context it's used in flux is different than fair share as a scheduling algorithm? How is that?
Fair-share is only one factor (of multiple) that influences a job's priority when it is submitted. Fair-share is mentioned as just one factor (of multiple) in the Multi-Factor Priority Plugin section, just above the Glossary, but perhaps I could do a better job making this more clear. What do you think? |
Yeah - I'm not sure the best way to do this, but I think we should / might give the reader definitions and then (maybe a second paragraph) explain the context for flux. Just reading the definition without that people would guess we use a fair share scheduling algorithm. |
Sorry, I am probably just misunderstanding you. Is the Multi-Factor Priority Plugin section not sufficient for what you are envisioning? My thinking there was that section outlines all of the factors currently enabled, which mentions fair-share as just one factor and a link to an expanded definition of what it means in the Glossary. |
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.
LGTM!
Thanks! Setting MWP |
Problem: flux-accounting doesn't have a clear definition for fair-share and its place in the priority plugin in terms of calculating a job's priority. Add 'fair-share' as a term in the Glossary section with an expanded definition. Make the "Glossary" section a referenceable one in the flux-accounting guide so that when fair-share is mentioned in the Multi-Factor Priority Plugin section, the expanded definition can be easily linked to.
background
flux-accounting doesn't have a clear definition for fair-share and its place in the priority plugin in terms of calculating a job's priority in the Accounting Guide.
This PR adds 'fair-share' as a term in the Glossary section with an expanded definition.
It also makes the "Glossary" section a reference-able one in the flux-accounting guide so that when fair-share is mentioned in the Multi-Factor Priority Plugin section, the expanded definition can be easily linked to.
leaving as [WIP] for now because I'm having trouble getting Sphinx installed on my recently updated Mac and can't build it locally 😔