simvue-io / simvue-io/python-api

Add a flush function to the Run class

Open
#590 0 comments 0 reactions 1 assignee View on GitHub

@kzscisoft is already working on this.

Since Nov 7, 2024.

Dominant language
Python
Stars
4
Forks
1
Avg merge
5d 8h
Merged PRs (30d)
4

Description

Sometimes the direct dispatcher is impractical to use, as it results in prohibitively many requests being made to the server. But in these cases, users may still want to be able to query metrics that they have already told a Run to upload.

For this case, we need a .flush() function which will empty any queues in the dispatcher (sending their contents to the server). Crucially, control should not flow out of the .flush() function until all those uploads have finished, so that any subsequent queries of that data are guaranteed to be correct.

The use case that has made this requirement apparent is using connectors (which upload lots of things to a run - so many that the direct dispatcher causes problems) with the optimization framework (where we often want to query the contents of a still-open run just after metrics have been sent to it).

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.