Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Better naming of types of aggregates #274

Open
vyasr opened this issue Mar 16, 2020 · 5 comments
Open

Better naming of types of aggregates #274

vyasr opened this issue Mar 16, 2020 · 5 comments
Labels
aggregation documentation Writing or editing documentation GSoC Google Summer of Code

Comments

@vyasr
Copy link
Contributor

vyasr commented Mar 16, 2020

FlowGroups provide a mechanism for grouping operations. We have proposals for job aggregation, and we also use the term bundle for groups of cluster jobs. We will also need to formalize a concept of aggregation for directives as part of #265. We're already seeing that the similarity in these terms is leading to confusion for developers. We should look into giving these concepts more descriptive names to reduce confusion about their individual roles.

@mikemhenry mikemhenry added the documentation Writing or editing documentation label May 11, 2020
@bdice bdice added GSoC Google Summer of Code aggregation labels May 14, 2020
@kidrahahjo
Copy link
Collaborator

@vyasr Please assign me this issue, I'll start working on this.

@csadorf
Copy link
Contributor

csadorf commented Jul 1, 2020

Generally in favor in working out a comprehensive and coherent glossary.

However, I'd suggest to avoid renaming previous concepts to avoid creating more confusion, especially since groups have just been released.

@vyasr
Copy link
Contributor Author

vyasr commented Jul 1, 2020

I agree, but I think we can do it by just augmenting existing names without losing the existing association, for instance consistently referring to bundles as "submission bundles", groups as "operation groups", and aggregates as "job aggregates" (or whatever terms we pick). Also I think a large part of this can come in the form of documentation more than anything else, I don't think we would need to change class names (although that may become more feasible depending on how much we "privatize" the API).

@csadorf
Copy link
Contributor

csadorf commented Jul 1, 2020

Let's work out the glossary first. Hopefully there is no strong need to rename anything as part of the API.

@kidrahahjo
Copy link
Collaborator

Since we're converting internally everything into aggregates, I think the methods like _create_run_job_operations should be renamed to maybe _create_run_job_aggregate_operations and similarly the class _JobOperation to _JobAggregateOperation.

I'll be happy to work on this after #336 gets merged.

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
aggregation documentation Writing or editing documentation GSoC Google Summer of Code
Projects
None yet
Development

No branches or pull requests

5 participants