Setting up Python SDK for Personalizer #26296

sharathmalladi · 2022-09-19T17:10:52Z

Description

Python SDK for Azure Cognitive Services Personalizer.
Swagger link: TBD

All SDK Contribution checklist:

The pull request does not introduce [breaking changes]
CHANGELOG is updated for new features, bug fixes or other significant changes.
I have read the contribution guidelines.

General Guidelines and Best Practices

Title of the pull request is clear and informative.
There are a small number of commits, each of which have an informative message. This means that previously merged commits do not appear in the history of the PR. For more information on cleaning up the commits in your PR, see this page.

Testing Guidelines

Pull request includes test coverage for the included changes.

check-enforcer · 2022-09-19T17:21:01Z

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run python - [service] - ci

…zure-sdk-for-python into personalizersdk

eng/tox/tox.ini

sdk/personalizer/azure-ai-personalizer/CHANGELOG.md

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/_patch.py

sdk/personalizer/azure-ai-personalizer/tests/test_configuration.py

sdk/personalizer/azure-ai-personalizer/tests/test_configuration_async.py

sdk/personalizer/ci.yml

Added @pytest.mark.asyncio decorator for async tests.

…into personalizersdk

kristapratico

Once the tests.yml is moved up a directory, we can run /azp run prepare-pipelines to create the CI pipeline for your library.

kristapratico · 2022-10-07T00:45:26Z

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/_patch.py

+            authentication_policy=kwargs.pop("authentication_policy", _authentication_policy(credential, **kwargs)),
+            **kwargs
+        )
+        self._default_language = kwargs.pop("default_language", None)


default_language is specific to the question answering client library, you can remove it. #Resolved

kristapratico · 2022-10-07T00:47:54Z

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/aio/_patch.py

+from azure.core.pipeline.policies import AzureKeyCredentialPolicy, AsyncBearerTokenCredentialPolicy
+from ._client import PersonalizerClient as PersonalizerClientGenerated
+
+__all__: List[str] = []  # Add all objects you want publicly available to users at this package level


this looks like a duplicate, it's defined on L83 #Resolved

Fixed. Thanks!

kristapratico · 2022-10-07T00:57:54Z

...ure-ai-personalizer/samples/async_samples/multi_slot_rank_actions_and_reward_events_async.py

+DESCRIPTION:
+    This sample demos sending a rank and reward call to personalizer for multi-slot configuration.
+USAGE: python multi_slot_rank_actions_and_reward_events_async.py
+"""


We should describe the environment variables needed to run this sample under the comment header. #Resolved

kristapratico · 2022-10-07T01:06:16Z

sdk/personalizer/azure-ai-personalizer/azure/ai/personalizer/operations/_operations.py

+        return cast(Iterator[bytes], deserialized)
+
+    @distributed_trace
+    def import_method(self, body: IO, **kwargs: Any) -> None:  # pylint: disable=inconsistent-return-statements


import is a keyword in Python so it looks like the generator is appending "method" to the method name. I missed this on the first review but we should probably give this a better name. Can you rename it through the swagger transform? Should look something like:

directive: - rename-operation: from: Model_Import to: Model_ImportModel

This will rename it to import_model (or whatever it should be named) #Resolved

Thanks for the suggestion. Fixed.

kristapratico · 2022-10-07T01:08:33Z

sdk/personalizer/azure-ai-personalizer/tests.yml

+      ServiceDirectory: personalizer
+      MatrixReplace:
+        - TestSamples=.*/true
+      Clouds: Canary


I don't think we need to run tests in Canary (it doesn't look like we do in the other languages).

Suggested change

Clouds: Canary

kristapratico · 2022-10-07T01:09:26Z

sdk/personalizer/azure-ai-personalizer/tests.yml

@@ -0,0 +1,18 @@
+trigger: none


This file should be up one level: sdk/personalizer/tests.yml #Resolved

sharathmalladi · 2022-10-07T22:14:54Z

/azp run prepare-pipelines

azure-pipelines · 2022-10-07T22:15:03Z

Azure Pipelines successfully started running 1 pipeline(s).

sharathmalladi · 2022-10-07T22:15:41Z

Added the comment in github pr.

In reply to: 1133773653

azure-sdk · 2022-10-07T22:55:42Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

azure-ai-personalizer

sharathmalladi · 2022-10-09T06:30:35Z

All comments have been addressed. This PR is being replaced with a different PR: #26719

sharathmalladi · 2022-10-10T20:18:54Z

Abandoning this PR as it had some leaked apikeys (the keys were rotated and so the risk is mitigated). This PR is superceded by this one: #26719

Setting up Python SDK for Personalizer

18bd3df

sharathmalladi and others added 7 commits September 22, 2022 16:55

Adding tests.

e0f8959

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-python

45c67c8

Merge branch 'main' into personalizersdk

7eabbd3

packaging updates for file inclusion

4e1d02e

Merge branch 'personalizersdk' of https://github.com/sharathmalladi/a…

1e090f8

…zure-sdk-for-python into personalizersdk

Fix lint errors.

adda7a6

Add async tests and samples.

06c50d2

sharathmalladi marked this pull request as ready for review September 27, 2022 00:30

sharathmalladi requested review from scbedd, benbp, weshaggard and lmazuel as code owners September 27, 2022 00:30

kristapratico self-requested a review September 27, 2022 00:37

kristapratico reviewed Sep 27, 2022

View reviewed changes

sharathmalladi added 6 commits September 27, 2022 14:26

Addressing feedback:

e52c7bf

Added @pytest.mark.asyncio decorator for async tests.

Added test recordings.

cdadb20

Merge branch 'main' of https://github.com/Azure/azure-sdk-for-python …

9e06ac2

…into personalizersdk

Added support for AAD authentication

1e549d4

Fixing tox errors.

c01123d

Addressing feedback. Update tests to use test proxy.

c929c2a

kristapratico reviewed Oct 7, 2022

View reviewed changes

Addressed more feedback comments.

ef96d81

sharathmalladi force-pushed the personalizersdk branch from 692b9c0 to ef96d81 Compare October 7, 2022 22:14

Merge branch 'main' into personalizersdk

4859d6d

sharathmalladi force-pushed the personalizersdk branch from d4df8e0 to 4859d6d Compare October 7, 2022 22:38

Fix spell check errors

95b2efd

sharathmalladi closed this Oct 9, 2022

Setting up Python SDK for Personalizer #26296

Setting up Python SDK for Personalizer #26296

Uh oh!

Conversation

sharathmalladi commented Sep 19, 2022

Description

All SDK Contribution checklist:

General Guidelines and Best Practices

Testing Guidelines

Uh oh!

check-enforcer bot commented Sep 19, 2022

What is Check Enforcer?

Why am I getting this message?

What should I do now?

What if I am onboarding a new service?

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

kristapratico left a comment

Choose a reason for hiding this comment

Uh oh!

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

Uh oh!

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

Uh oh!

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

Uh oh!

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

Uh oh!

kristapratico Oct 7, 2022

Choose a reason for hiding this comment

Uh oh!

kristapratico Oct 7, 2022 • edited by sharathmalladi Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sharathmalladi Oct 7, 2022

Choose a reason for hiding this comment

Uh oh!

sharathmalladi commented Oct 7, 2022

Uh oh!

azure-pipelines bot commented Oct 7, 2022

Uh oh!

sharathmalladi commented Oct 7, 2022

Uh oh!

azure-sdk commented Oct 7, 2022

Uh oh!

sharathmalladi commented Oct 9, 2022

Uh oh!

sharathmalladi commented Oct 10, 2022

Uh oh!

Uh oh!

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading

kristapratico Oct 7, 2022 •

edited by sharathmalladi

Loading