You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@submarine.apache.org by pi...@apache.org on 2021/02/25 06:51:32 UTC
[submarine] branch master updated: SUBMARINE-746. Update Submarine
python SDK documentation
This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 0aed2d7 SUBMARINE-746. Update Submarine python SDK documentation
0aed2d7 is described below
commit 0aed2d767fe07ba51f44677ae3e4638f9eb1b6a1
Author: Kevin <pi...@apache.org>
AuthorDate: Sat Feb 20 01:40:36 2021 +0800
SUBMARINE-746. Update Submarine python SDK documentation
### What is this PR for?
- Fix the typo and update some contents in https://submarine.apache.org/docs/gettingStarted/python-sdk
- Add `.asf.yaml` under `website/static`, so that when we use `yarn deploy` to push a commit to `submarine-site`, `.asf.yaml` will automatically help us update the https://submarine.apache.org/
### What type of PR is it?
[ Improvement | Documentation]
### Todos
* [ ] - Task
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-746
### How should this be tested?
https://travis-ci.com/github/pingsutw/hadoop-submarine/builds/217657855
### Screenshots (if appropriate)
### Questions:
* Does the license files need an update? No
* Is there breaking changes for older versions? No
* Does this needs documentation? No
Author: Kevin <pi...@apache.org>
Signed-off-by: Kevin <pi...@apache.org>
Closes #518 from pingsutw/SUBMARINE-746 and squashes the following commits:
2f1f183f [Kevin] SUBMARINE-746. Update Submarine python SDK documentation
---
website/docs/gettingStarted/python-sdk.md | 34 ++++++++++++++++++++++---------
website/static/.asf.yaml | 12 +++++++++++
2 files changed, 36 insertions(+), 10 deletions(-)
diff --git a/website/docs/gettingStarted/python-sdk.md b/website/docs/gettingStarted/python-sdk.md
index f93983a..b736a9d 100644
--- a/website/docs/gettingStarted/python-sdk.md
+++ b/website/docs/gettingStarted/python-sdk.md
@@ -1,5 +1,5 @@
---
-title: Install Python SDK
+title: Submarine Python SDK
---
<!--
@@ -23,7 +23,9 @@ under the License.
Submarine Python SDK can runs on any machine and it will talk to Submarine Server via REST API. So you can install Submarine Python SDK on your laptop, a gateway machine, your favorite IDE (like PyCharm/Jupyter, etc.).
-#### Prepare Python Environment to run Submarine SDK
+Furthermore, Submarine supports an extensible package of CTR models based on **TensorFlow** and **PyTorch** along with lots of core components layers that can be used to easily build custom models. You can train any model with `model.train()` and `model.predict()`.
+
+## Prepare Python Environment to run Submarine SDK
Submarine SDK requires Python3.7+.
It's better to use a new Python environment created by `Anoconda` or Python `virtualenv` to try this to avoid trouble to existing Python environment.
@@ -38,29 +40,41 @@ python3 virtualenv-16.0.0/virtualenv.py venv
. venv/bin/activate
```
-#### Install Submarine SDK
+## Install Submarine SDK
+
+### Install SDK from pypi.org (recommended)
-**Install SDK from pypi.org (recommended)**
+Starting from `0.4.0`, Submarine provides Python SDK. Please change it to a proper version needed.
-Starting from 0.4.0, Submarine provides Python SDK. Please change it to a proper version needed.
+More detail: https://pypi.org/project/apache-submarine/
```bash
-pip install submarine-sdk==<REPLACE_VERSION>
+# Install latest stable version
+pip install apache-submarine
+# Install specific version
+pip install apache-submarine==<REPLACE_VERSION>
```
-**Install SDK from source code**
+### Install SDK from source code
Please first clone code from github or go to `http://submarine.apache.org/download.html` to download released source code.
```bash
git clone https://github.com/apache/submarine.git
+# (optional) chackout specific branch or release
git checkout <correct release tag/branch>
cd submarine/submarine-sdk/pysubmarine
pip install .
```
-#### Run with Submarine Python SDK
+## Manage Submarine Experiment
+
+Assuming you've installed submarine on K8s and forward the traefik service to localhost, now you can open a Python shell, Jupyter notebook or any tools with Submarine SDK installed.
+
+Follow [SDK experiment example](https://github.com/apache/submarine/blob/master/submarine-sdk/pysubmarine/example/submarine_experiment_sdk.ipynb) to run an experiment.
+
+## Training a DeepFM model
+The Submarine also supports users to train an easy-to-use CTR model with a few lines of code and a configuration file, so they don’t need to reimplement the model by themself. In addition, they can train the model on both local on distributed systems, such as Hadoop or Kubernetes.
-Assuming you've installed submarine on K8s and forward the service to localhost, now you can open a Python shell, Jupyter notebook or any tools with Submarine SDK installed.
-Follow [SDK experiment example](https://github.com/apache/submarine/blob/master/submarine-sdk/pysubmarine/example/submarine_experiment_sdk.ipynb) to try the SDK.
\ No newline at end of file
+Follow [SDK DeepFM example](https://github.com/apache/submarine/blob/master/submarine-sdk/pysubmarine/example/deepfm_example.ipynb) to try the model.
\ No newline at end of file
diff --git a/website/static/.asf.yaml b/website/static/.asf.yaml
new file mode 100644
index 0000000..dcb5644
--- /dev/null
+++ b/website/static/.asf.yaml
@@ -0,0 +1,12 @@
+# This file allow Apache to hlep us automatically update the website,
+# when we push commit to https://github.com/apache/submarine-site
+publish:
+ whoami: asf-site
+
+github:
+ description: "Apache Submarine website"
+ homepage: https://submarine.apache.org/
+ enabled_merge_buttons:
+ squash: true
+ merge: false
+ rebase: false
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@submarine.apache.org
For additional commands, e-mail: dev-help@submarine.apache.org