apache/hugegraph-doc

[Enhance]add JobAPI doc for OLAP algorithms in HugeServer

Aperta

#205 aperta il 14 apr 2023

Vedi su GitHub
 (5 commenti) (2 reazioni) (0 assegnatari)JavaScript (119 fork)auto 404
enhancementhelp wanted

Metriche repository

Star
 (69 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente di JobAPI e il codebase di HugeServer per comprendere gli algoritmi OLAP e i parametri, quindi aggiungi una nuova pagina di documentazione con istruzioni per l'uso seguendo l'esempio fornito.
Tech stack
Nessuno
Dominio
databaseapi
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
75