Skip to content
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

Merged
merged 1 commit into from
Mar 1, 2024

Conversation

cmoussa1
Copy link
Member

@cmoussa1 cmoussa1 commented Jan 31, 2024

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 😔

@cmoussa1 cmoussa1 added the documentation Improvements or additions to documentation label Jan 31, 2024
@cmoussa1 cmoussa1 changed the title [WIP] glossary: add expanded definition for 'fair-share' glossary: add expanded definition for 'fair-share' Jan 31, 2024
@cmoussa1 cmoussa1 marked this pull request as ready for review January 31, 2024 21:29
Copy link
Member

@vsoch vsoch left a 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?

@cmoussa1
Copy link
Member Author

cmoussa1 commented Feb 1, 2024

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?

@vsoch
Copy link
Member

vsoch commented Feb 1, 2024

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.

@cmoussa1
Copy link
Member Author

cmoussa1 commented Feb 1, 2024

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.

Copy link
Contributor

@grondo grondo left a comment

Choose a reason for hiding this comment

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

LGTM!

@cmoussa1
Copy link
Member Author

cmoussa1 commented Mar 1, 2024

Thanks! Setting MWP

@cmoussa1 cmoussa1 added the merge-when-passing mark PR for auto-merging by mergify.io bot label Mar 1, 2024
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.
@mergify mergify bot merged commit 23ed592 into flux-framework:master Mar 1, 2024
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation merge-when-passing mark PR for auto-merging by mergify.io bot
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants