chore: update generate fabric doc #2214
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
fabric doc PR preview: https://github.com/MicrosoftDocs/fabric-docs-pr/pull/3984 |
JessicaXYWang
changed the title
|
/azp run |
|
Azure Pipelines failed to run 1 pipeline(s). |
mhamilton723
reviewed
May 2, 2024
mhamilton723
reviewed
May 2, 2024
tools/docgen/docgen/channels.py
Outdated
| self.input_dir = input_dir | ||
| self.output_dir = output_dir | ||
| self.notebooks = notebooks | ||
| self.output_structure = kwargs.get("output_structure", "hierarchy") |
There was a problem hiding this comment.
does it need to be kwargs or can we add an output structure argument explicitly here?
mhamilton723
reviewed
May 2, 2024
| import shutil | ||
|
|
||
| class LearnDocPreprocessor(Preprocessor): | ||
| def __init__(self, remove_tags=None, **kwargs): |
There was a problem hiding this comment.
nit: perhaps call this tags_to_remove so it doesent get confused as a boolean variable
mhamilton723
reviewed
May 2, 2024
Comment on lines
61
to
62
| self.input_dir = self.attributes.get("input_dir", None) # access local images | ||
| self.notebook_path = self.attributes.get("notebook_path", None) # access local images |
There was a problem hiding this comment.
nit: are these comments still relevant here?
mhamilton723
reviewed
May 2, 2024
| @@ -5,7 +5,7 @@ | |||
| "cell_type": "markdown", | |||
| "metadata": {}, | |||
| "source": [ | |||
| "# Classification - before and after SynapseML" | |||
| "# Classification tasks- SparkML vs SynapseML" | |||
There was a problem hiding this comment.
Suggested change
| "# Classification tasks- SparkML vs SynapseML" | |
| "# Classification - SparkML vs SynapseML" |
mhamilton723
reviewed
May 2, 2024
tools/docgen/docgen/channels.py
Outdated
| True, | ||
| ) | ||
| content = self._read_rst(full_input_file) | ||
| # TODO: Not tested yet |
There was a problem hiding this comment.
this still applicable?
mhamilton723
reviewed
May 2, 2024
tools/docgen/docgen/manifest.yaml
Outdated
| @@ -44,22 +49,22 @@ channels: | |||
| - path: Explore Algorithms/Classification/Quickstart - SparkML vs SynapseML.ipynb | |||
| filename: classification-before-and-after-synapseml | |||
| metadata: | |||
| title: Classification - before and after SynapseML | |||
| title: Classification tasks using SynapseML | |||
There was a problem hiding this comment.
Suggested change
| title: Classification tasks using SynapseML | |
| title: Classification using SynapseML |
mhamilton723
reviewed
May 2, 2024
| ] | ||
| }, | ||
| "source": [ | ||
| "see our [embedding guide](./Quickstart%20-%20OpenAI%20Embedding)." |
There was a problem hiding this comment.
Suggested change
| "see our [embedding guide](./Quickstart%20-%20OpenAI%20Embedding)." | |
| "For more information on using `OpenAIEmbedding` see our [embedding guide](./Quickstart%20-%20OpenAI%20Embedding)." |
mhamilton723
reviewed
May 2, 2024
| @@ -322,7 +322,18 @@ | |||
| "source": [ | |||
| "### Generating Text Embeddings\n", | |||
| "\n", | |||
| "In addition to completing text, we can also embed text for use in downstream algorithms or vector retrieval architectures. Creating embeddings allows you to search and retrieve documents from large collections and can be used when prompt engineering isn't sufficient for the task. For more information on using `OpenAIEmbedding`, see our [embedding guide](./Quickstart%20-%20OpenAI%20Embedding)." | |||
| "In addition to completing text, we can also embed text for use in downstream algorithms or vector retrieval architectures. Creating embeddings allows you to search and retrieve documents from large collections and can be used when prompt engineering isn't sufficient for the task. For more information on using `OpenAIEmbedding`." | |||
There was a problem hiding this comment.
Suggested change
| "In addition to completing text, we can also embed text for use in downstream algorithms or vector retrieval architectures. Creating embeddings allows you to search and retrieve documents from large collections and can be used when prompt engineering isn't sufficient for the task. For more information on using `OpenAIEmbedding`." | |
| "In addition to completing text, we can also embed text for use in downstream algorithms or vector retrieval architectures. Creating embeddings allows you to search and retrieve documents from large collections and can be used when prompt engineering isn't sufficient for the task." |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #2214 +/- ##
==========================================
+ Coverage 86.19% 86.22% +0.03%
==========================================
Files 327 327
Lines 16715 16715
Branches 1495 1495
==========================================
+ Hits 14407 14413 +6
+ Misses 2308 2302 -6 ☔ View full report in Codecov by Sentry. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
merged Azure docc PR: https://github.com/MicrosoftDocs/azure-docs-pr/pull/275170 |
mhamilton723
approved these changes
May 15, 2024
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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?
Does this PR change any dependencies?
Does this PR add a new feature? If so, have you added samples on website?
website/docs/documentationfolder.Make sure you choose the correct class
estimators/transformersand namespace.DocTablepoints to correct API link.yarn run startto make sure the website renders correctly.<!--pytest-codeblocks:cont-->before each python code blocks to enable auto-tests for python samples.WebsiteSamplesTestsjob pass in the pipeline.