Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add prerequisites - openai and cognitive services resources #2008

Merged
merged 16 commits into from
Jul 13, 2023

Conversation

JessicaXYWang
Copy link
Contributor

@JessicaXYWang JessicaXYWang commented Jul 10, 2023

Add doc:
create Azure OpenAi, Cognitive Services resources
start with Fabric, Synapse Analytics

@github-actions
Copy link

Hey @JessicaXYWang 👋!
Thank you so much for contributing to our repository 🙌.
Someone from SynapseML Team will be reviewing this pull request soon.

We use semantic commit messages to streamline the release process.
Before your pull request can be merged, you should make sure your first commit and PR title start with a semantic prefix.
This helps us to create release messages and credit you for your hard work!

Examples of commit messages with semantic prefixes:

  • fix: Fix LightGBM crashes with empty partitions
  • feat: Make HTTP on Spark back-offs configurable
  • docs: Update Spark Serving usage
  • build: Add codecov support
  • perf: improve LightGBM memory usage
  • refactor: make python code generation rely on classes
  • style: Remove nulls from CNTKModel
  • test: Add test coverage for CNTKModel

To test your commit locally, please follow our guild on building from source.
Check out the developer guide for additional guidance on testing your change.

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Summary by GPT-4

This commit adds two new Jupyter notebooks to the documentation:

  1. prerequisites_azure_resources.ipynb: This notebook provides instructions on setting up Cognitive Services and Azure OpenAI resources for SynapseML. It explains how to create resources, obtain API keys, and set up Azure OpenAI Resource and Cognitive Services resource.

  2. prerequisites_platforms.ipynb: This notebook provides instructions on setting up computing platforms for SynapseML, specifically Microsoft Fabric and Synapse Analytics. It explains how to get access to Fabric, create a new notebook or attach an existing one to a lakehouse, update SynapseML on Fabric, create a Synapse workspace and launch Synapse Studio, create a serverless Apache Spark pool, and update SynapseML on Azure Synapse Analytics.

These notebooks will help users understand the prerequisites for using SynapseML with Azure resources and computing platforms.

Suggestions

No suggestions are needed as the PR has no clear issues.

@JessicaXYWang
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Jul 10, 2023

Codecov Report

Merging #2008 (5184255) into master (25c4582) will decrease coverage by 0.33%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #2008      +/-   ##
==========================================
- Coverage   87.06%   86.74%   -0.33%     
==========================================
  Files         306      306              
  Lines       16064    16064              
  Branches      840      840              
==========================================
- Hits        13986    13934      -52     
- Misses       2078     2130      +52     

see 14 files with indirect coverage changes

]
},
"source": [
"To Create a new Azure OpenAI Resource and obtain an OpenAI API key, you need\n",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the prereqs should be the same moreorless for azure openai and cog services, things like azure accounts will be needed for both

"## Synapse Analytics\n",
"**Azure Synapse** is an enterprise analytics service that accelerates time to insight across data warehouses and big data systems.\n",
"\n",
"SynapseML is preinstalled on Synapse Analytics. To start with Synapse Analytics:"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make this one mirror the changed form to keep them in parity

},
"source": [
"* [Create a Synapse workspace](https://docs.microsoft.com/en-us/azure/synapse-analytics/get-started-create-workspace)\n",
"* [Create a serverless Apache Spark pool](https://docs.microsoft.com/en-us/azure/synapse-analytics/get-started-analyze-spark#create-a-serverless-apache-spark-pool)"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should describe creating a notebook and also link to the synapse section of a multiplatform guide for version updating

Copy link
Collaborator

@mhamilton723 mhamilton723 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lovely start to this!

JessicaXYWang and others added 8 commits July 10, 2023 21:50
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Copy link
Collaborator

@mhamilton723 mhamilton723 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few more comments but its looking really nice!

JessicaXYWang and others added 4 commits July 12, 2023 11:32
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
@JessicaXYWang
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mhamilton723 mhamilton723 merged commit 46a56e1 into microsoft:master Jul 13, 2023
5 of 6 checks passed
JessicaXYWang added a commit to JessicaXYWang/SynapseML that referenced this pull request Sep 14, 2023
…crosoft#2008)

* add prerequisites - openai and cognitive services resources

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_platforms.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_platforms.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_platforms.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_platforms.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* update setting up docs

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Update notebooks/documentation/prerequisites_azure_resources.ipynb

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

* Apply suggestions from code review

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>

---------

Co-authored-by: Mark Hamilton <mhamilton723@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants