Add AI examples extension #1196

mirdaki · 2020-01-13T22:25:59Z

This is a new extension (in preview) to use the Aladdin service to power all examples in help content. It is pending on this PR being merged into the core CLI to work properly.

This checklist is used to make sure that common guidelines for a pull request are followed.

General Guidelines

Have you run azdev style <YOUR_EXT> locally? (pip install azdev required)
Have you run python scripts/ci/test_index.py -q locally?

For new extensions:

My extension description/summary conforms to the Extension Summary Guidelines.

azuresdkci · 2020-01-13T22:26:21Z

If this PR is for a new extension or change to an existing extension, use the following to try out the changes in this PR:

docker run -it microsoft/azure-cli:latest
export EXT=<NAME>
pip install --upgrade --target ~/.azure/cliextensions/$EXT "git+https://github.com/mirdaki/azure-cli-extensions.git@ai-examples#subdirectory=src/$EXT&egg=$EXT"

yonzhan · 2020-01-13T23:53:10Z

add to S164.

src/ai-examples/README.rst

haroldrandom · 2020-01-14T06:23:27Z

src/index.json

+                    "run_requires": [
+                        {
+                            "requires": [
+                                "azure-cli-core"


No need to explicitly to specify azure-cli-core I think, azure-cli-extensions depends on azure-cli, and azure-cli depends on azure-cli-core.

You can have a try cause it failed CI.

OK, removing the azure-cli-core dependency.

haroldrandom · 2020-01-14T06:23:33Z

src/ai-examples/setup.py

+]
+
+DEPENDENCIES = [
+    'azure-cli-core'


No need to explicitly to specify azure-cli-core I think, azure-cli-extensions depends on azure-cli, and azure-cli depends on azure-cli-core.

You can have a try cause it failed CI.

OK, removing the azure-cli-core dependency.

haroldrandom

Please take a look comments and the reason why failed CI.

Please don't forget to update sha256Digest value once code change.

The next version of the CLI (presumably 2.0.81), will be needed for the extension to work. However, it seems that some of the build issues might be related to that version not existing. So to pass the CI/CD testing (and to check that there are no other issues), the extension min version has been set to the original default of 2.0.65.

mirdaki · 2020-01-15T22:20:39Z

OK, made the requested changes.

One other thing that might be causing the problems is that this extension needs some code that hasn't yet shipped in the Azure CLI. I had the min version set to be 2.0.81 (presumably the next version), but as that doesn't yet exist, it might of caused an issue. For now I've reverted it to 2.0.65, but that needs to be updated before this PR gets merged.

Juliehzl · 2020-01-19T04:56:13Z

src/ai-examples/azext_ai_examples/azext_metadata.json

+{
+    "azext.isPreview": true,
+    "azext.minCliCoreVersion": "2.0.65",
+    "azext.maxCliCoreVersion": "2.1.0"


Can we remove this constraint if you are not sure about the max version requirement?

Yes, good suggestion!

Juliehzl · 2020-01-19T05:02:55Z

src/index.json

        ],
+        "ai-examples": [
+            {
+                "downloadUrl": "https://aladdinprodwestus.blob.core.windows.net/aladdin-extensions/ai_examples-0.1.0-py2.py3-none-any.whl",


download link should be generated by CLI team, and you don't need to provide it.

OK, I was unclear how that was supposed to happen. I'll remove it for now.

Err, how am I supposed to update the index.json then? I had been using the azdev extension publish command to do that up till now, but if y'all will be publishing it, that doesn't make sense to use. The azdev extension update-index command looks like the right thing, but it also needs a URL to work.

@Juliehzl any update on this?

@mirdaki,

Put whl file in CLI storage or your storage?
If no special reasons, usually we recommend to put whl file in our (CLI) storage as most of extensions do now. Also it's beneficial for our future release pipeline automation as pipeline automation has no access to your storage.

currently the workflow is:

You build a whl file

You send whl file to us

We'll upload your whl file to our storage (as you don't have permission to upload to our storage)

We tell you the downloadUrl

You update the index.json with the downloadUrl we provide to you

In the future (one or two sprints later),
All these manual steps will be automated in our extension release pipeline.

Juliehzl · 2020-01-19T05:13:07Z

src/ai-examples/azext_ai_examples/custom.py

+
+# Replacements for core functions
+def provide_examples(help_file):
+    return replace_examples(help_file)


Can we provide two options for users to select?

Because this is an experiment, we were planning on getting feedback for one scenario at a time. The append code is there, because that was the original plan, but we've decided to have just the Aladdin examples to better test them.

haroldrandom · 2020-01-19T07:12:24Z

src/ai-examples/setup.py

+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.4',
+    'Programming Language :: Python :: 3.5',
+    'Programming Language :: Python :: 3.6',


Didn't support 3.7 and 3.8?

I was using the what the boilerplate from azdev provided, will update.

haroldrandom · 2020-01-19T07:13:01Z

src/ai-examples/setup.py

+    'Programming Language :: Python :: 2',
+    'Programming Language :: Python :: 2.7',
+    'Programming Language :: Python :: 3',
+    'Programming Language :: Python :: 3.4',


3.4 is not supported at azure-cli-core

I was using the what the boilerplate from azdev provided, will update.

…tensions into ai-examples

mirdaki · 2020-01-22T22:42:45Z

I've pushed an update that address some of the comments. The sha has not been updated yet, because I'm still waiting for an answer from @Juliehzl about how to properly set the downloadUrl and update the index.json.

yonzhan · 2020-01-23T00:11:16Z

@Juliehzl please help with the above comment.

…tensions into ai-examples

mirdaki · 2020-02-10T21:32:45Z

@Juliehzl and @yonzhan, I'm still waiting on an answer on how I'm suppose to publish the extension.

If the CLI team is supposed to supply the URL, does that also mean the CLI team will upload the extension to their own blob storage? In that case is the PR done and y'all take care of the rest?

If not, am I supposed to continue publishing the extention to our own blob storage using azdev extension publish? Or is it something else I need to do?

Juliehzl · 2020-02-11T08:16:26Z

Hi @mirdaki, when the code is ready to merge, I can help you publish the extension if you want to store your extension wheel in cli storage account.
In addition, you publish it to your own storage account with --storage-account parameter. But you need to update index.json with download link.
Please let me know if you hope we help you do the publish.

…tensions into ai-examples

mirdaki · 2020-02-11T23:01:01Z

@Juliehzl I've updated index.json to use the correct metadata and point to the updated blob storage. I am ready for the extension wheel to be uploaded to the CLI storage account and merge this PR.

mirdaki · 2020-02-24T17:19:56Z

@haroldrandom and @Juliehzl, I've switched the downloadUrl to the CLI storage and am ready for the code to be merged.

mirdaki-ms added 9 commits December 26, 2019 15:41

Initial extension creation

6cfdacd

Add ability to add Aladdin examples to the default help ones

043ea9a

Removed unused boilerplate for Aladdin extension

fae34bf

Add test and clean up Aladdin extension code

467d8f3

Rename extension from Aladdin to "ai-examples"

1afbd22

Add a min version of 2.0.80, which should have the hook

3cc1cf4

Update the de-duplication to clean text first

5f98770

Change the default operation to replace the existing examples

7848e78

Update summary to be more compliant with guidelines

d8add28

mirdaki changed the title ~~AI examples~~ Add AI examples extension Jan 13, 2020

Add ai-examples to index.json as part of publishing

424d83e

mirdaki requested a review from zikalino as a code owner January 13, 2020 23:12

yonzhan requested review from Juliehzl, haroldrandom and qwordy January 13, 2020 23:52

yonzhan assigned qwordy Jan 13, 2020

yonzhan added this to the S164 milestone Jan 13, 2020

haroldrandom reviewed Jan 14, 2020

View reviewed changes

src/ai-examples/README.rst Show resolved Hide resolved

haroldrandom reviewed Jan 14, 2020

View reviewed changes

haroldrandom suggested changes Jan 14, 2020

View reviewed changes

Juliehzl reviewed Jan 19, 2020

View reviewed changes

Merge branch 'master' into ai-examples

8f23d83

haroldrandom reviewed Jan 19, 2020

View reviewed changes

mirdaki-ms added 2 commits January 22, 2020 14:39

Update Python and max version number to be accurate

277163f

Merge branch 'ai-examples' of https://github.com/mirdaki/azure-cli-ex…

c321740

…tensions into ai-examples

Jianhui Harold and others added 4 commits February 5, 2020 11:23

Merge branch 'master' into ai-examples

8a08d57

Update to accurate minimum CLI version

253ba25

Merge branch 'ai-examples' of https://github.com/mirdaki/azure-cli-ex…

ede70af

…tensions into ai-examples

Merge branch 'master' into ai-examples

ead3587

mirdaki-ms added 2 commits February 11, 2020 14:30

Update index with new hash and other metadata

53205d5

Merge branch 'ai-examples' of https://github.com/mirdaki/azure-cli-ex…

f8f3a61

…tensions into ai-examples

yonzhan modified the milestones: S164, S165 Feb 12, 2020

haroldrandom approved these changes Feb 13, 2020

View reviewed changes

yonzhan modified the milestones: S165, S166 Feb 15, 2020

yonzhan assigned jsntcy Feb 21, 2020

Switch to CLI download

d9c3666

Juliehzl approved these changes Feb 25, 2020

View reviewed changes

Merge branch 'master' into ai-examples

0836330

haroldrandom merged commit 6629998 into Azure:master Feb 25, 2020

ManuInNZ pushed a commit to ManuInNZ/azure-cli-extensions that referenced this pull request Apr 11, 2020

[AI-Examples] Add AI examples extension (Azure#1196)

a37a840

Add AI examples extension #1196

Add AI examples extension #1196

Uh oh!

Conversation

mirdaki commented Jan 13, 2020

General Guidelines

Uh oh!

azuresdkci commented Jan 13, 2020

Uh oh!

yonzhan commented Jan 13, 2020

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

haroldrandom left a comment

Choose a reason for hiding this comment

Uh oh!

mirdaki commented Jan 15, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsntcy Feb 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mirdaki Jan 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mirdaki commented Jan 22, 2020

Uh oh!

yonzhan commented Jan 23, 2020

Uh oh!

mirdaki commented Feb 10, 2020

Uh oh!

Juliehzl commented Feb 11, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mirdaki commented Feb 11, 2020

Uh oh!

mirdaki commented Feb 24, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

jsntcy Feb 21, 2020 •

edited

Loading

mirdaki Jan 21, 2020 •

edited

Loading

Juliehzl commented Feb 11, 2020 •

edited

Loading