rapidsai / rapidsai/cugraph-docs

[DOC]: Create cuGraph Service user facing docs

Open
#23 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc
Dominant language
Shell
Stars
5
Forks
23
Avg merge
13h 44m
Merged PRs (30d)
9

Description

How would you describe the priority of this documentation request

High

Describe the future/missing documentation
  • how to install the cugraph-service server in an environment where the server is to be run (ie. appropriate machine/cluster with 1 or more GPUs that is accessible to machines running the cugraph-service client)
  • how to start the cugraph-service server in the server environment - this includes details about CLI options, how to expose GPUs, how to start and maintain the dask cluster the server is to use for MG, etc.
  • how to install the cugraph-service client in the client environment (ie. the environment where the users' application using cugraph-service will be, which may or may not be the same machine running the server) Note: the client can be installed separately and without the server software installed.
Where have you looked?

https://github.com/rapidsai/cugraph/tree/branch-23.02/python/cugraph-service

Code of Conduct
  • I agree to follow cuGraph's Code of Conduct
  • I have searched the open documentation issues and have found no duplicates for this bug report

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the cugraph-service directory on the referenced branch at python/cugraph-service. Document separate server and client installation, server startup and CLI options, GPU exposure, and Dask cluster setup and maintenance; the work is done when users can deploy the server and install and use the client from the documented steps.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, infrastructure
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.