Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples - #592

Merged
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes
Jul 28, 2018
Merged

Fixes #591: typos, adding the type attribute to lists, and moving the name attribute for some examples#592
sfilipi merged 4 commits into
dotnet:masterfrom
sfilipi:docFormattingFixes

Conversation

@sfilipi

Copy link
Copy Markdown
Member

Testing the documentation in the doc.microsoft.com staging environment, i noticed a few typos, unescaped apostrophes, and missing xml tag attributes.

Fixes#591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson

@TomFinleyTomFinley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you @sfilipi !

</member>
<example>
<example name="OGD">
<example name="OGD">

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example [](start = 5, length = 7)

is this not an error to have nested examples? #Pending

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Yea I see it's used everywhere. I wonder why though?


In reply to: 205926076 [](ancestors = 205926076)

@sfilipisfilipiJul 28, 2018

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it is legal in xml.
The internal example node is needed by the documentation to display the snippet as an example.

I needed a named wrapper to get the node, and ...just called it example.

this is how they are being included:

I don't need to include them with the /* notation, i can just include the named node itself, but i wasn't sure if the docs tools would tolerate the name attribute on it.
But with both you and Ivan commenting on it, though, might be worth to try it, and if they are robust to it, clean this two level example.

In my TODO list.


In reply to: 205926101 [](ancestors = 205926101,205926076)

</member>
<example>
<example name="OGD">
<example name="OGD">

@Ivanidzo4kaIvanidzo4kaJul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

example name="OGD" [](start = 5, length = 18)

out of curiosity, is order of having name / not having name matter? In AP example you have and here you have #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

it depends how you include the node in the code.

see the long answer to Pete's comment. Should clarify it.
Note the * notation:


In reply to: 205926135 [](ancestors = 205926135)

<remarks>
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the
value and using the hash as an index in the bag.
CategoricalHashOneHotVectorizer converts a categorical value into an indicator array by hashing the value and using the hash as an index in the bag.

@Zruty0Zruty0Jul 28, 2018

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

the value [](start = 104, length = 9)

why removing the newline here, but not, say, in line 33? #Pending

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

I am not sure why the text is broken in newlines identically how my text is structured for the page corresponding to the CategoricalHashOneHotVectorizer, and it is flowing differently for the CategoricalOneHotVectorizer, disregarding line indentations in the XML.

Could be because the text in the other one is inside the tags; and we should always use the para tags to keep the convenience formatting in the xml.

links if curious:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview

https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.categoricalhashonehotvectorizer?view=ml-dotnet&branch=smoke-test-preview


In reply to: 205926140 [](ancestors = 205926140)

@Zruty0Zruty0 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

:shipit:

@sfilipi
sfilipi merged commit 502e422 into dotnet:masterJul 28, 2018
@sfilipi
sfilipi deleted the docFormattingFixes branch July 28, 2018 00:58
For each row, the entire text string appearing in the input column is defined as a category.
The output of this transform is an indicator vector.
The output of this transform is an indicator vector.</para>
Each slot in this vector corresponds to a category in the dictionary, so its length is the size of the built dictionary.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 This line should be in a paragraph element.

<remarks>
In machine learning​ it is a pretty common and powerful approach to utilize the already trained model in the process of defining features.
<para>One such example would be the use of model's scores as features to downstream models. For example, we might run clustering on the original features,
<para>One such example would be the use of model&apos;s scores as features to downstream models. For example, we might run clustering on the original features,

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is this required? It's awkward to read and seems like it would be easy to regress.

<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)
{
ReplaceWith = NAHandleTransformReplacementKind.Mean

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

💡 Should likely be indented

<example name="NAHandle">
<example>
<code language="csharp">
pipeline.Add(new MissingValueHandler(&quot;FeatureCol&quot;, &quot;CleanFeatureCol&quot;)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Why is the &quot; escape needed? I would only expect this if it appeared as the value of an XML attribute.

It can be changed to true for known length vectors, but it results in an error if changed to false for variable length vectors.
</para>
</remarks>
<seealso cref=" Microsoft.ML.Runtime.Data.MetadataUtils.Kinds.HasMissingValues"/>

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

❔ Is this missing a T: prefix? It's unclear why the others are given in full form but I noticed this one is different.

codemzs pushed a commit to codemzs/machinelearning that referenced this pull request Aug 1, 2018
…ng the name attribute for some examples (dotnet#592)
* Fixes issue 591: typos, adding the type to lists, and fixing the name attribute in OGD and Poisson
* getting just the content under the memeber node, not the member itself.
* merging from master
@ghostghost locked as resolved and limited conversation to collaborators Mar 29, 2022
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix documentation formatting

5 participants

@sfilipi@sharwell@Ivanidzo4ka@TomFinley@Zruty0