apache/hugegraph-doc

[Enhance]add JobAPI doc for OLAP algorithms in HugeServer

Offen

#205 geöffnet am 14.04.2023

Auf GitHub ansehen
 (5 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)JavaScript (119 Forks)auto 404
enhancementhelp wanted

Repository-Metriken

Stars
 (69 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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-Richtung
Überprüfen Sie die vorhandene JobAPI Dokumentation und die HugeServer Codebasis, um OLAP Algorithmen und Parameter zu verstehen, und fügen Sie dann eine neue Dokumentationsseite mit Anleitungen gemäß dem bereitgestellten Beispiel hinzu.
Tech Stack
Keine
Domain
databaseapi
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75