ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-02-07 13:23:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix docstrings

Browse Source
This commit is contained in:
allegroai 2022-06-06 14:18:49 +03:00
parent 4021b23506
commit f64e1f34c5
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
examples/pipeline/pipeline_from_decorator.py
View File

@ -92,7 +92,7 @@ if __name__ == '__main__':
# set the pipeline steps default execution queue (per specific step we can override it with the decorator) # set the pipeline steps default execution queue (per specific step we can override it with the decorator)
# PipelineDecorator.set_default_execution_queue('default') # PipelineDecorator.set_default_execution_queue('default')
# Run the pipeline steps as subprocesses on the current machine, great for local executions # Run the pipeline steps as subprocesses on the current machine, great for local executions
# (for easy development / debugging, use `PipelineDecorator.pipeline()` to execute steps as regular functions) # (for easy development / debugging, use `PipelineDecorator.debug_pipeline()` to execute steps as regular functions)
PipelineDecorator.run_locally() PipelineDecorator.run_locally()
# Start the pipeline execution logic. # Start the pipeline execution logic.

10
examples/services/monitoring/slack_alerts.py
View File

@ -1,13 +1,13 @@
""" """
Create a ClearML Monitoring Service that posts alerts on Slack Channel groups based on some logic Create a ClearML Monitoring Service that posts alerts on Slack Channel groups based on some logic
Creating a new Slack Bot (Allegro ClearML Bot): Creating a new Slack Bot (ClearML Bot):
1. Login to your Slack account 1. Login to your Slack account
2. Go to https://api.slack.com/apps/new 2. Go to https://api.slack.com/apps/new
3. Give the new App a name (For example "Allegro Train Bot") and select your workspace 3. Give the new App a name (For example "ClearML Bot") and select your workspace
4. Press Create App 4. Press Create App
5. In "Basic Information" under "Display Information" fill in the following fields 5. In "Basic Information" under "Display Information" fill in the following fields
- In "Short description" insert "Allegro Train Bot" - In "Short description" insert "ClearML Bot"
- In "Background color" insert #202432 - In "Background color" insert #202432
6. Press Save Changes 6. Press Save Changes
7. In "OAuth & Permissions" under "Scopes" click on "Add an OAuth Scope" and 7. In "OAuth & Permissions" under "Scopes" click on "Add an OAuth Scope" and
@ -18,7 +18,7 @@ Creating a new Slack Bot (Allegro ClearML Bot):
8. Now under "OAuth Tokens & Redirect URLs" press on "Install App to Workspace", 8. Now under "OAuth Tokens & Redirect URLs" press on "Install App to Workspace",
then hit "Allow" on the confirmation dialog then hit "Allow" on the confirmation dialog
9. Under "OAuth Tokens & Redirect URLs" copy the "Bot User OAuth Access Token" by clicking on "Copy" button 9. Under "OAuth Tokens & Redirect URLs" copy the "Bot User OAuth Access Token" by clicking on "Copy" button
10. To use the copied API Token in the Allegro ClearML Slack service, 10. To use the copied API Token in the ClearML Slack service,
execute the script with --slack_api "<api_token_here>" (notice the use of double quotes around the token) execute the script with --slack_api "<api_token_here>" (notice the use of double quotes around the token)
We are done! We are done!
@ -311,7 +311,7 @@ def main():
# Let everyone know we are up and running # Let everyone know we are up and running
start_message = \ start_message = \
'{}Allegro ClearML Slack monitoring service started\nMonitoring project \'{}\''.format( '{}ClearML Slack monitoring service started\nMonitoring project \'{}\''.format(
(args.message_prefix + ' ') if args.message_prefix else '', (args.message_prefix + ' ') if args.message_prefix else '',
args.project or 'all') args.project or 'all')
slack_monitor.post_message(start_message) slack_monitor.post_message(start_message)