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 QandA notebook. #2029

Merged
merged 5 commits into from
Jul 24, 2023

Conversation

aydan-at-microsoft
Copy link
Contributor

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Briefly describe the changes included in this Pull Request.

How is this patch tested?

  • I have written tests (not required for typo or doc fix) and confirmed the proposed feature/bug-fix/change works.

Does this PR change any dependencies?

  • [x ] No. You can skip this section.
  • Yes. Make sure the dependencies are resolved correctly, and list changes here.

Does this PR add a new feature? If so, have you added samples on website?

  • [x ] No. You can skip this section.
  • Yes. Make sure you have added samples following below steps.
  1. Find the corresponding markdown file for your new feature in website/docs/documentation folder.
    Make sure you choose the correct class estimators/transformers and namespace.
  2. Follow the pattern in markdown file and add another section for your new API, including pyspark, scala (and .NET potentially) samples.
  3. Make sure the DocTable points to correct API link.
  4. Navigate to website folder, and run yarn run start to make sure the website renders correctly.
  5. Don't forget to add <!--pytest-codeblocks:cont--> before each python code blocks to enable auto-tests for python samples.
  6. Make sure the WebsiteSamplesTests job pass in the pipeline.

@github-actions
Copy link

Hey @aydan-at-microsoft 👋!
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.

@aydan-at-microsoft aydan-at-microsoft changed the title add QandA notebook. docs: add QandA notebook. Jul 20, 2023
Co-authored-by: Kartavya Neema <[email protected]>
Co-authored-by: Amir Jafari <[email protected]>
Co-authored-by: Kartavya Neema <[email protected]>
Co-authored-by: Amir Jafari <[email protected]>
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

In this commit, a new notebook called "Quickstart - Document Question and Answering with PDFs" has been added to the "Explore Algorithms/AI Services" section. This notebook demonstrates how to develop a context-aware question answering framework for any form of a document using OpenAI models, SynapseML, and Azure AI Services. The notebook assumes that PDF documents are the source of data, but the same framework can be easily extended to other document formats as well.

Suggestions

No suggestions are needed as the changes in this PR seem to be clear and well-structured.

@aydan-at-microsoft
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Commenter does not have sufficient privileges for PR 2029 in repo microsoft/SynapseML

@aydan-at-microsoft
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 21, 2023

Codecov Report

Merging #2029 (80d7e73) into master (df2712a) will decrease coverage by 14.49%.
The diff coverage is n/a.

@@             Coverage Diff             @@
##           master    #2029       +/-   ##
===========================================
- Coverage   87.09%   72.60%   -14.49%     
===========================================
  Files         306      306               
  Lines       16068    16068               
  Branches      860      860               
===========================================
- Hits        13994    11666     -2328     
- Misses       2074     4402     +2328     

see 77 files with indirect coverage changes

@aydan-at-microsoft
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

No commit pushedDate could be found for PR 2029 in repo microsoft/SynapseML

@aydan-at-microsoft
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mhamilton723
Copy link
Collaborator

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@mhamilton723 mhamilton723 merged commit 4841ddb into microsoft:master Jul 24, 2023
JessicaXYWang pushed a commit to JessicaXYWang/SynapseML that referenced this pull request Sep 14, 2023
* add QandA notebook.

Co-authored-by: Kartavya Neema <[email protected]>
Co-authored-by: Amir Jafari <[email protected]>

* address comments.

Co-authored-by: Kartavya Neema <[email protected]>
Co-authored-by: Amir Jafari <[email protected]>

* rename cog services to ai services

* add test to exclude, wait for synapse fix

---------

Co-authored-by: Kartavya Neema <[email protected]>
Co-authored-by: Amir Jafari <[email protected]>
Co-authored-by: Mark Hamilton <[email protected]>
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.

3 participants