.. OpenFGL documentation master file, created by
   sphinx-quickstart on Fri May 31 17:37:50 2024.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to OpenFGL's documentation!
===================================

.. figure:: img/openfgl_logo.png
   :width: 600
   :align: center


**OpenFGL** is a benchmark for Federated Graph Learning.
It provides a fair and comprehensive platform to evaluate existing FGL works and facilitate future FGL research.


.. note::

   This project is under active development.

Citation
--------
Please cite our paper (and the respective papers of the methods used) if
you use this code in your own work:

::

   @misc{li2024openfglcomprehensivebenchmarksfederated,
      title={OpenFGL: A Comprehensive Benchmarks for Federated Graph Learning}, 
      author={Xunkai Li and Yinlin Zhu and Boyang Pang and Guochen Yan and Yeyu Yan and Zening Li and Zhengyu Wu and Wentao Zhang and Rong-Hua Li and Guoren Wang},
      year={2024},
      eprint={2408.16288},
      archivePrefix={arXiv},
      primaryClass={cs.LG},
      url={https://arxiv.org/abs/2408.16288}, 
   }



Installation
------------
::
   
      pip install openfgl-lib==1.0.2




.. toctree::
   :glob:
   :maxdepth: 3
   :caption: Getting Started

   example
   fgl_tutorial



.. toctree::
   :glob:
   :maxdepth: 3
   :caption: Modules

   module_client
   module_server
   module_task


.. toctree::
   :glob:
   :maxdepth: 3
   :caption: Resources

   fgl_studies