GH-16182: Updating user guide page Welcome to reflect makersaurus guidelines #16183
Conversation
hannah-tillman
requested review from
mmalohlava,
mn-mikke,
wendycwong,
valenad1,
maurever,
sebhrusen,
tomasfryda and
syzonyuliia
There was a problem hiding this comment.
LGTM, thanks @hannah-tillman! I like the split into more pages by type of user.
I have only few notes.
|
|
||
| To begin, download a copy of H2O from the `Downloads page <https://h2o.ai/resources/download/>`__. | ||
|
|
||
| 1. Click H2O Open Source Platform or scroll down to the H2O section. Here you have access to the different ways to download H2O: |
There was a problem hiding this comment.
I am surprised we called our product just H2O and not H2O-3. 🤔 I think it collides with the company name a little bit and can be confusing.
There was a problem hiding this comment.
I think it might be because of how old the guide is. I can update to H2O-3 as I go through now, though, to be less confusing if we think that's best?
There was a problem hiding this comment.
It would be great. But we should check it with @wendycwong and @mmalohlava. On our website, the product is also called H2O.
There was a problem hiding this comment.
@hannah-tillman : I check the resource page and h2o-3 is used to denote h2o opensource:
There was a problem hiding this comment.
So, we either use H2O open source or just use H2O-3. I suggest using H2O-3 after setting H2O open source == H2O-3.
|
|
||
| H2O Flow is a notebook-style open source UI for H2O. It's a web-based interactive environment that lets you combine code execution, text, mathematics, plots, and rich media in a single document (similar to iPython Notebooks). | ||
|
|
||
| See more about `H2O Flow <../flow.html>`__. |
There was a problem hiding this comment.
I clicked on the URL and it goes to error.
| For first-time users, we recomment downloading the latest alpha release and the default standalone option (the Download and Run tab) as the installation method. Make sure to install Java if it is not already installed. | ||
|
|
||
| .. note:: | ||
| By default, this setup is open. Follow `security guidelines <../security.html>`__ if you want to secure your installation. |
There was a problem hiding this comment.
security guidelines URL lead to error
| - `Generalized Linear Model (GLM) <https://github.com/h2oai/h2o-3/blob/master/h2o-docs/src/product/tutorials/glm/glm.md>`__ | ||
| - `Gradient Boosting Machine (GBM) <https://github.com/h2oai/h2o-3/blob/master/h2o-docs/src/product/tutorials/gbm/gbm.md>`__ | ||
| - `K-Means <https://github.com/h2oai/h2o-3/blob/master/h2o-docs/src/product/tutorials/kmeans/kmeans.md>`__ | ||
|
|
There was a problem hiding this comment.
Please somehow tell the user that Flow also support new algos and list them:
adaboost
aggregator
anovaglm
coxph
stacked ensemble
gam
glrm
isotonic regression
modelselection
naivebayes
pca
psvm
rulefit
isolation forest/extended isolation forest
uplift
word2vec
| Algorithms | ||
| ---------- | ||
|
|
||
| `This section describes the science behind our algorithms <../data-science.html#data-science>`__ and provides a detailed, per-algorithm view of each model type. |
| h2o-3 user$ | ||
|
|
||
| 4. Run the following command to retrieve sample datasets. These datasets are used throughout the user guide and within the `booklets <../additional-resources.html#algorithms>`__. | ||
|
|
There was a problem hiding this comment.
booklet URL leads to error
| Anaconda Cloud users | ||
| -------------------- | ||
|
|
||
| You can run H2O in an Anaconda Cloud environment. Conda 2.7, 3.5, and 3.6 repositories are supported (as are a number of H2O versions). See Anaconda's `official H2O package <https://anaconda.org/h2oai/h2o/files>`__ to view a list of all available H2O versions. You can refer to the `Install on Anaconda Cloud <../downloading.html#install-on-anaconda-cloud>`__ section for information about installing H2O in an Anaconda Cloud. |
There was a problem hiding this comment.
The last link for anaconda cloud does not work.
| Installing H2O with R | ||
| ~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| You can find instructions for using H2O with Python in the `Downloading and installing H2O <../downloading.html#install-in-r>`__ section and on the `Downloads page <http://h2o-release.s3.amazonaws.com/h2o/latest_stable.html>`__. |
There was a problem hiding this comment.
linke for Downloading and installing H2O is not working.
|
|
||
| .. note:: | ||
|
|
||
| If you are running R on Linus, then you must install ``libcurl`` which allows H2O to communicate with R. We also recommend disabling SElinux and any firewalls (at least initially until you confirmed H2O can initialize). |
There was a problem hiding this comment.
Do you mean Linux and not Linus?
|
|
||
| H2O is licensed under the `Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_. | ||
| H2O's REST API allow access to all the capabilities of H2O frm an external program or script through JSON over HTTP. The REST API is used by H2O's web interface (Flow UI), R binding (H2O-R), and Python binding (H2O-Python). |
| ~~~~~~~~~~~~~~~~~ | ||
|
|
||
| H2O runs on Java. To build H2O or run H2O tests, the 64-bit JDK is required. To run the H2O binary using either the command line, R, or Python packages, only 64-bit JRE is required. | ||
| The speed, quality, ease-of-use, and model-deployment for our various supervised and unsupervised algorithms (such as Deep Learning, GLRM, or our tree ensembles) make H2O a highly sought after API for big data data science. |
There was a problem hiding this comment.
You list some algos here, I would suggest you list all of them here to make people know all of our offerings:
adaboost
aggregator
anovaglm
coxph
deep learning
stacked ensemble
gam
glm
glrm
isotonic regression
kmeans
modelselection
naivebayes
pca
psvm
rulefit
isolation forest/extended isolation forest
uplift
word2vec
#16182
This PR is a large overhaul over the Welcome page structure. A while ago I was also tasked with making the Welcome page less overwhelming which is why this is a more in-depth update than any of the other pages will be.
Any feedback is super welcome! This is a bigger change than normal, but breaks down the information into more digestible chunks. Let me know your thoughts :)