Commit f9436ee0 by Wenjie Huang

add toc of docs

parent 7a5c91db
Advanced Data Preprocessing
===========================
.. note::
详细介绍一下StarryGL几种数据管理类,例如GraphData,的使用细节,内部索引结构的设计和底层操作。
\ No newline at end of file
Advanced Concepts
=================
.. toctree::
ts_sampling
pp_training
tp_training
data_proc
\ No newline at end of file
Distributed Partition Parallel
==============================
.. note::
分布式分区并行训练部分
\ No newline at end of file
Distributed Timeline Parallel
=============================
.. note::
分布式时序并行
\ No newline at end of file
Distributed Temporal Sampling
=============================
.. note::
基于分布式时序图采样的训练模式
\ No newline at end of file
starrygl.distributed
====================
.. note::
自动生辰的api文档,需要在starrygl源代码目录里添加码内注释
.. currentmodule:: starrygl.distributed
.. autosummary::
DistributedContext
\ No newline at end of file
Package References
==================
.. toctree::
distributed
\ No newline at end of file
Cheatsheets
===========
.. note::
可以放一些框架内置的GNN模型,GNN数据集清单以及默认的接口调用规则,参考
`pyg cheatsheets <https://pytorch-geometric.readthedocs.io/en/latest/cheatsheet/data_cheatsheet.html>`_
\ No newline at end of file
# Configuration file for the Sphinx documentation builder. import os
# import sys
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- Project information ----------------------------------------------------- sys.path.insert(0, os.path.abspath("../.."))
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information import starrygl
project = 'StarryGL' project = 'StarryGL'
copyright = '2023, StarryGL Team' copyright = '2023, StarryGL Team'
author = 'StarryGL Team' author = 'StarryGL Team'
# -- General configuration --------------------------------------------------- version = starrygl.__version__
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration release = starrygl.__version__
extensions = []
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"sphinx.ext.duration",
]
templates_path = ['_templates'] templates_path = ['_templates']
exclude_patterns = [] exclude_patterns = []
...@@ -23,5 +26,5 @@ exclude_patterns = [] ...@@ -23,5 +26,5 @@ exclude_patterns = []
# -- Options for HTML output ------------------------------------------------- # -- Options for HTML output -------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
html_theme = 'alabaster' html_theme = 'sphinx_rtd_theme'
html_static_path = ['_static'] html_static_path = ['_static']
External Resources
==================
.. note::
!!!放置一些StarryGL相关的论文,GNN相关的项目以及有助于使用StarryGL的资源,可以参考:
`PyG Resources <https://pytorch-geometric.readthedocs.io/en/latest/external/resources.html>`_
\ No newline at end of file
Get Started
===========
.. toctree::
install_guide
intro_example
\ No newline at end of file
Installation
============
.. note::
安装方法
\ No newline at end of file
Introduction by Example
=======================
.. note::
安装好之后,快速开始一个时序图模型训练。先展示一下基础使用,可以是单机的?
\ No newline at end of file
.. StarryGL documentation master file, created by StarryGL Documentation
sphinx-quickstart on Sat Dec 23 01:02:22 2023. ======================
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to StarryGL's documentation!
====================================
.. toctree:: .. toctree::
:maxdepth: 2 guide/index
:caption: Contents: tutorial/index
advanced/index
api/python/index
cheatsheets/index
external/index
Indices and tables .. Indices and tables
================== .. ==================
* :ref:`genindex` .. * :ref:`genindex`
* :ref:`modindex` .. * :ref:`modindex`
* :ref:`search` .. * :ref:`search`
User Cases and Applications
===========================
.. note::
放一些时序GNN的用例和应用
\ No newline at end of file
Preparing the Temporal Graph Dataset
====================================
.. note::
包含从原始数据开始的数据清洗和预处理步骤,最终形成可以被StarryGL使用的数据文件
\ No newline at end of file
Distributed Training
====================
.. note::
开始介绍分布式训练相关的方法,并展示一个最简单的分布式DDP训练流程
\ No newline at end of file
Tutorials
===============
.. toctree::
intro
module
dataset
application
distributed
\ No newline at end of file
Introduction to Temporal GNN
==============================================
.. note::
简单介绍一下时序GNN,应用场景,需要解决的问题等,相当于一个总体的介绍
Creating Temporal GNN Models
============================
.. note::
介绍如何创建GNN模型,找最经典最简洁的两个例子即可。包括 **离散时间动态图模型** 模型构建和 **连续时间动态图模型**。
\ No newline at end of file
-r requirements.txt
# used by docs
sphinx-autobuild
sphinx_rtd_theme
matplotlib
ipykernel
\ No newline at end of file
--extra-index-url https://download.pytorch.org/whl/cu118
torch==2.1.1+cu118
torchvision==0.16.1+cu118
torchaudio==2.1.1+cu118
--extra-index-url https://data.pyg.org/whl/torch-2.1.0+cu118.html
torch_geometric==2.4.0
pyg_lib==0.3.1+pt21cu118
torch_scatter==2.1.2+pt21cu118
torch_sparse==0.6.18+pt21cu118
torch_cluster==1.6.3+pt21cu118
torch_spline_conv==1.2.2+pt21cu118
ogb
tqdm
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment