📝 Add execution info to README #143
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Fix minor things such as:
- spacing after headings
- proper headings hierarchy
- missing code block language setting
- use more generic `shell` instead of `bash`
when no bash-specific syntax is used
Fetch ID, title, and counter from the current execution.
ruksi
approved these changes
Jan 7, 2025
Comment on lines
+176
to
+188
| ## Execution Info | ||
|
|
||
| `valohai.execution` contains information about the current execution context. | ||
|
|
||
| ```python | ||
| import valohai | ||
|
|
||
| execution_config = valohai.execution().config | ||
| print(f"Execution ID: {execution_config.id}") | ||
| print(f"Execution title: {execution_config.title}") | ||
| print(f"Execution counter: {execution_config.counter}") | ||
| ``` | ||
|
|
There was a problem hiding this comment.
a small note how they behave outside of Valohai might be nice but maybe sometime later 👍️
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documents #141
Add an example of using
valohai.execution().config.Also contains some formatting fix ups to bring the README up to snuff.