[SPARK-16485][DOC][ML] Fixed several inline formatting in ml features doc #14194
Conversation
|
Thanks for finding this. |
|
@jkbradley Could you please take a look at this simple fix? |
| Rescaled(e_i) = \frac{e_i - E_{min}}{E_{max} - E_{min}} * (max - min) + min | ||
| \end{equation}` | ||
| For the case `E_{max} == E_{min}`, `Rescaled(e_i) = 0.5 * (max + min)` | ||
| For the case `$E_{max} == E_{min}$`, `$Rescaled(e_i) = 0.5 * (max + min)$` |
There was a problem hiding this comment.
Nit: write = instead of == in the first equation?
It looks like this is repeated in the scaladoc for MinMaxScaler. Can that be updated too?
There was a problem hiding this comment.
Thanks for the review!
Nit: write = instead of == in the first equation?
Both are ok for me, but in the MinMaxScaler's scaladoc we're also using ==, so we update both places or leave it as is.
It looks like this is repeated in the scaladoc for MinMaxScaler. Can that be updated too?
I don't think we can format math formulas in scaladoc, e.g. from MinMaxScaler doc it seems not formatted at all.
There was a problem hiding this comment.
Hm, right. Actually we have several instances where latex is used in scaladoc and it doesn't render, like https://spark.apache.org/docs/2.0.0-preview/api/scala/index.html#org.apache.spark.mllib.optimization.LogisticGradient
Most are private classes. It's even in a log message in GradientDescentSuite. This looks OK to me as-is; you're also welcome to clean up all the useless latex in log messages / scaladoc while here.
There was a problem hiding this comment.
OK, I'll follow up with another PR to remove latex in scaladocs and log messages.
|
Jenkins test this please |
|
Test build #62833 has finished for PR 14194 at commit
|
… doc ## What changes were proposed in this pull request? Fixed several inline formatting in ml features doc. Before: <img width="475" alt="screen shot 2016-07-14 at 12 24 57 pm" src="https://cloud.githubusercontent.com/assets/717363/16827974/1e1b6e04-49be-11e6-8aa9-4a0cb6cd3b4e.png"> After: <img width="404" alt="screen shot 2016-07-14 at 12 25 48 pm" src="https://cloud.githubusercontent.com/assets/717363/16827976/2576510a-49be-11e6-96dd-92a1fa464d36.png"> ## How was this patch tested? Genetate the docs locally by `SKIP_API=1 jekyll build` and view it in the browser. Author: Shuai Lin <linshuai2012@gmail.com> Closes #14194 from lins05/fix-docs-formatting. (cherry picked from commit 3b6e1d0) Signed-off-by: Sean Owen <sowen@cloudera.com>
|
Merged to master/2.0 to match original change |
4 participants
What changes were proposed in this pull request?
Fixed several inline formatting in ml features doc.
Before:
After:
## How was this patch tested?Genetate the docs locally by
SKIP_API=1 jekyll buildand view it in the browser.