Add Java tutorial #2320
Add Java tutorial #2320
Conversation
zhanglei1949
force-pushed
the
java-tutorial
branch
from
dd1c5d4
to
af1b5d9
Compare
docs/java_tutorials.md
Outdated
| Follow the tutorials below, give it a shot on trying exploring GraphScope Java. | ||
|
|
||
| - [Querying graph via GraphScope JavaSDK](https://graphscope.io/docs/latest/java-tutorial-0-pie.html) |
There was a problem hiding this comment.
- Please use relative URLs, otherwise I cannot find these files in the preview or other deployments. (e.g., intranet in the future. )
- Please use the filename as unified underline
_rather than-.
|
You may want to check the preview on https://alibaba-graphscope-build-pr-2320.surge.sh/ |
docs/java-tutorial-1-giraph.md
Outdated
|
|
||
| ## Try some example giraph apps | ||
|
|
||
| We provide some example giraph algorithms, i.e. SSSP, PageRank in [grape-demo.jar](https://graphscope.oss-cn-beijing.aliyuncs.com/jar/grape-demo-0.18.0-shaded.jar). |
There was a problem hiding this comment.
Do we provide this in the central repo?
There was a problem hiding this comment.
Not yet, grape-demo.jar is not provided in maven central repo, since users shall not use it in their project.
docs/java-tutorial-0-pie.md
Outdated
| </dependency> | ||
| ``` | ||
|
|
||
| To address the dependency issue in jar packaging, you shall package all your |
There was a problem hiding this comment.
You may want to give details about your reminder about packaging, may be step by step?
docs/java-tutorial-0-pie.md
Outdated
|
|
||
| After computation, you can obtain the results stored in context with the help of [`Context`](https://graphscope.io/docs/reference/context.html#context). | ||
|
|
||
| ## GraphScope JavaSDK with Github Template |
There was a problem hiding this comment.
in addition to this file, is it possible to provide a .pynb for this doc?
docs/java-tutorial-1-giraph.md
Outdated
|
|
||
| You can implement your algorithm towards Giraph' original API. Although almost all APIs are supported, there are indeed some limitation of Giraph-on-Graphscope. | ||
|
|
||
| - Currently graph modification API is not supported. |
There was a problem hiding this comment.
can you provide an example,
the java file comes from the examples from Giraph Repo.
build it and run on GS.
There was a problem hiding this comment.
You mean starting from examples in giraph repo, show users how to build and run them on GS?
docs/java-tutorial-1-giraph.md
Outdated
| """Or lauch session in k8s cluster""" | ||
| sess = graphscope.session(cluster_type='hosts') | ||
|
|
||
| graphscope_session.add_lib("path/to/grape-demo.jar") |
There was a problem hiding this comment.
I just wonder if this is a path on local? or on the cluster?
There was a problem hiding this comment.
Path on local. Coordinator will distribute the jar to cluster.
docs/java-tutorial-2-graphx.md
Outdated
|
|
||
| ## Run example GraphX apps | ||
|
|
||
| Several GraphX algorithms are also contained in [grape-demo.jar](https://graphscope.oss-cn-beijing.aliyuncs.com/jar/grape-demo-0.18.0-shaded.jar). |
There was a problem hiding this comment.
I just wonder is this the Java way? maybe a central managed jar, import to their pom, would be better?
There was a problem hiding this comment.
From my point of view, the jar we provided contains some example algorithms, not like a SDK or some dependent jar.
If user include grape-demo.jar as dependency, then he still need to create a new project and then compile, to get a packed jar.
docs/java-tutorial-2-graphx.md
Outdated
|
|
||
| First, you also need to prepare the dataset. | ||
| ```bash | ||
| git clone -b master --single-branch --depth=1 https://github.com/7br/gstest.git ${GS_TEST_DIR} |
There was a problem hiding this comment.
Since the we already has a "demo" jar, i suggest we include the small test data in the demo to simplify the whole process.
There was a problem hiding this comment.
Agreed. But user still need to be aware of downloading data. What about let user just download one specific file we need? like
wget https://raw.githubusercontent.com/GraphScope/gstest/master/p2p-31.eThere was a problem hiding this comment.
I think it would be better.
docs/java-tutorial-2-graphx.md
Outdated
|
|
||
| ### Prepare Environment | ||
|
|
||
| The GraphX-GraphScope integration depends on serveral environment variables. We provide a shell script, user shall `source` this script before submit a graphx job. |
There was a problem hiding this comment.
Please organize this code, do not depend on copy-paste for users.
e.g., using graphscope/cli
generate a .graphscope_4spark.env
and then ask user to export a single file.
There was a problem hiding this comment.
I have created stubs for you:
https://github.com/GraphScope/cli/blob/main/src/spark_classpath_command.sh
docs/java-tutorial-2-graphx.md
Outdated
| ### Submit to Spark | ||
|
|
||
| ```bash | ||
| export EXTRA_CP=${GRAPHSCOPE_HOME}/lib/:${GRAPE_RUNTIME_JAR}:${GRAPHX_SDK_JAR} |
There was a problem hiding this comment.
We will export this env var from cli script.
docs/java-tutorial-2-graphx.md
Outdated
| --class com.alibaba.graphscope.example.graphx.BFSTest ${GRAPE_DEMO_JAR} ${GS_TEST_DIR}/p2p-31.e 2 1 | ||
| ``` | ||
|
|
||
| Remember to replace the placeholders like `${master_url}` ,`${num_executors}` with |
There was a problem hiding this comment.
Made it simple
docs/java-tutorial-2-graphx.md
Outdated
|
|
||
| ### Prepare Environment | ||
|
|
||
| The GraphX-GraphScope integration depends on serveral environment variables. We provide a shell script, user shall `source` this script before submit a graphx job. |
There was a problem hiding this comment.
Please double check and unify all the occurrence of
graphx, Graphx, to GraphX
docs/java-tutorial-2-graphx.md
Outdated
| ```bash | ||
| export EXTRA_CP=${GRAPHSCOPE_HOME}/lib/:${GRAPE_RUNTIME_JAR}:${GRAPHX_SDK_JAR} | ||
|
|
||
| ./bin/spark-submit --verbose \ |
There was a problem hiding this comment.
is it possible we generate this command for copy/paste
There was a problem hiding this comment.
Maybe I will export this as env variable in cli.
zhanglei1949
force-pushed
the
java-tutorial
branch
from
af1b5d9
to
ea05036
Compare
|
I also noticed that a file named |
Through this PR, the jvm opts specified by |
zhanglei1949
force-pushed
the
java-tutorial
branch
3 times, most recently
from
273c9ee
to
1a28ae0
Compare
zhanglei1949
force-pushed
the
java-tutorial
branch
2 times, most recently
from
2ad3255
to
8b34a40
Compare
zhanglei1949
force-pushed
the
java-tutorial
branch
3 times, most recently
from
dafc148
to
1acb803
Compare
update doc s project to simple f update doc graphx naming update tutorials mod graphx doc
zhanglei1949
force-pushed
the
java-tutorial
branch
from
1acb803
to
96cd830
Compare
|
😭 Deploy PR Preview ee5185e failed. Build logs
🤖 By surge-preview |
What do these changes do?
Related issue number
Add java tutorials for GRAPE-jdk.
Fix #2292