Skip to content

Add an optional run_id_suffix config - #230

Open
JosephMarinier wants to merge 2 commits into
mainfrom
pr/joseph/run-id-suffix
Open

JosephMarinier wants to merge 2 commits into
mainfrom
pr/joseph/run-id-suffix

Conversation

@JosephMarinier

Copy link
Copy Markdown
Collaborator

Add an optional run_id_suffix config to distinguish different runs. Until now, we have been hacking a suffix into the run ID by overriding the alias of the last pipeline part (TTS or S2S), which can be error-prone.

to distinguish different runs. Until now, we have been hacking a suffix into the run id by overriding the alias of the last pipeline part (TTS or S2S), which can be error-prone.

@raghavm243512 raghavm243512 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

looks good, maybe a nice name for this could be "experiment_tag"?

Super minor ofc, but I like when things explain their purpose in their name

Comment thread src/eva/models/config.py Outdated
"timestamp and model name(s)", # Overwritten by _set_default_run_id()
description="Run identifier, auto-generated if not provided",
)
run_id_suffix: str = Field("", description="Optional string appended to auto-generated run identifier")

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Thanks, @raghavm243512, for the feedback!

I like when things explain their purpose in their name

Agree! 👍 It's worth reflecting on the name. Thank you!

I'm hesitant to introduce the notion of "experiment". We usually refer to a "run", hence the run_id. To me, experiment_tag lacks conveying WHAT it does or WHERE you'll see it. Does it only go in the config.json? I appreciate that run_id_suffix clearly conveys that it's going to be appended to the run_id.

But I agree with you that "suffix" doesn't help with the purpose or WHY using it. And it's not really important if it goes in the suffix, the prefix, or somewhere in the middle. 🤔

Here are a few ideas, with some new combinations:

  • run_id_suffix
  • experiment_tag
  • run_id_tag or rud_tag
  • run_id_label or run_label
  • run_id_note or run_note
  • run_id_extra or run_extra

It's hard to find a short name that conveys the what, where, and why. I guess the missing ones simply need to be clear in the eva --help documentation.

What do you think?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I like run_label or run_tag

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants