From 05333e9b7a112306099afc508292a38e6caa6267 Mon Sep 17 00:00:00 2001 From: erezalg <52002872+erezalg@users.noreply.github.com> Date: Wed, 17 Aug 2022 11:05:29 +0300 Subject: [PATCH] Add PR \ Issue templates (#742) * Add PR \ Issue templates * Add pipe decorator get step's task example Co-authored-by: Erez Schnaider --- .github/ISSUE_TEMPLATE/bug_report.md | 29 ++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 +++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 11 ++++++++ examples/pipeline/pipeline_from_decorator.py | 5 ++++ 4 files changed, 61 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..b7de073c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a bug report to help us improve +labels: bug +assignees: '' + +--- + +Thank you for helping us making ClearML better! + + +## Describe the bug +A clear and concise description of what the bug is. + + +## To reproduce +Exact steps to reproduce the bug. Provide example code if possible. + +## Expected behaviour +What is the expected behaviour? What should've happened but didn't? + +## Environment +* Server type (self hosted \ app.clear.ml) +* ClearML SDK Version +* ClearML Server Version (Only for self hosted). Can be found on the bottom right corner of the settings screen. +* Python Version +* OS (Windows \ Linux \ Macos) +## Related Discussion +If this continues a slack thread, please provide a link to the original slack thread. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..7147b51c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,16 @@ +--- +name: Feature Request +about: Suggest an idea for ClearML +title: '' +assignees: '' + +--- + +## Proposal Summary +Explain your proposed feature. + +## Motivation +Explain the use case that needs this feature + +## Related Discussion +If this continues a slack thread, please provide a link to the original slack thread. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000..ec18a92d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,11 @@ +## Related Issue \ discussion +If this patch originated from a github issue or slack conversation, please paste a link to the original discussion
+ +## Patch Description +Description of what does the patch do. If the patch solves a bug, explain what the bug is and how to reproduce it +(If not already mentioned in the original conversation)
+ +## Testing Instructions +Instructions of how to test the patch or reproduce the issue the patch is aiming to solve + +## Other Information diff --git a/examples/pipeline/pipeline_from_decorator.py b/examples/pipeline/pipeline_from_decorator.py index 12926996..0d7a065e 100644 --- a/examples/pipeline/pipeline_from_decorator.py +++ b/examples/pipeline/pipeline_from_decorator.py @@ -52,9 +52,14 @@ def step_three(data): # make sure we have pandas for this step, we need it to use the data_frame import pandas as pd # noqa from sklearn.linear_model import LogisticRegression + from clearml import Task X_train, X_test, y_train, y_test = data model = LogisticRegression(solver='liblinear', multi_class='auto') model.fit(X_train, y_train) + score = model.score(X_test,y_test) + # Get current step's Task + task = Task.current_task() + task.get_logger().report_single_value(name='accuracy',value=score) return model