apache/hugegraph-doc

[Enhance]add JobAPI doc for OLAP algorithms in HugeServer

Open

#205 opened on Apr 14, 2023

View on GitHub
 (5 comments) (2 reactions) (0 assignees)JavaScript (119 forks)auto 404
enhancementhelp wanted

Repository metrics

Stars
 (69 stars)
PR merge metrics
 (PR metrics pending)

Description

Problem Type (问题类型)

None

Your Question (问题描述)

To enable users to quickly apply integrated OLAP algorithms, it is recommended to add a job API to the document RESTful API module and provide instructions for usage.

  • AlgorithmAPI

Environment (环境信息) Server Version: 1.0.0 (Apache Release Version) Backend: MySQL 8.0.32 hugegraph-hubble hugegraph-loader

For example Run LPA Algorithm job

  1. Load demo data into the hugegraph with hugegraph-loader

     bin/hugegraph-loader.sh -g hugegraph -f example/file/struct.json -s example/file/schema.groovy

    image

  2. Post http://localhost:8080/graphs/hugegraph/jobs/algorithm/lpa by PostMan

    image

  3. View the result of the algorithm execution in hugegraph-hubble Task status: image

    Lap algo summary image

    Graph node label detail: image

Contributor guide

Research direction
Examine the existing JobAPI documentation and HugeServer codebase to understand OLAP algorithms and parameters, then add a new doc page with usage instructions following the provided example.
Tech stack
None
Domain
databaseapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75