From 8d1b0e4ee74d89dbacc05fda79b40254c88588cf Mon Sep 17 00:00:00 2001 From: Nina Miolane Date: Wed, 27 Nov 2024 08:00:20 -0800 Subject: [PATCH 1/4] Cleanup of readme + index of doc website --- README.md | 2 +- docs/index.rst | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 080b6f1c..2c7ed2b3 100755 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Assess how your model compares against state-of-the-art topological neural netwo [![Lint](https://github.com/geometric-intelligence/TopoBenchmark/actions/workflows/lint.yml/badge.svg)](https://github.com/geometric-intelligence/TopoBenchmark/actions/workflows/lint.yml) [![Test](https://github.com/geometric-intelligence/TopoBenchmark/actions/workflows/test.yml/badge.svg)](https://github.com/geometric-intelligence/TopoBenchmark/actions/workflows/test.yml) [![Codecov](https://codecov.io/gh/geometric-intelligence/TopoBenchmark/branch/main/graph/badge.svg)](https://app.codecov.io/gh/geometric-intelligence/TopoBenchmark) -[![Docs](https://img.shields.io/badge/docs-website-brightgreen)](https://geometric-intelligence.github.io/topobenchmarkx/index.html) +[![Docs](https://img.shields.io/badge/docs-website-brightgreen)](https://geometric-intelligence.github.io/topobenchmark/index.html) [![Python](https://img.shields.io/badge/python-3.10+-blue?logo=python)](https://www.python.org/) [![license](https://badgen.net/github/license/geometric-intelligence/TopoBenchmark?color=green)](https://github.com/geometric-intelligence/TopoBenchmark/blob/main/LICENSE) [![slack](https://img.shields.io/badge/chat-on%20slack-purple?logo=slack)](https://join.slack.com/t/geometric-intelligenceworkspace/shared_invite/zt-2k63sv99s-jbFMLtwzUCc8nt3sIRWjEw) diff --git a/docs/index.rst b/docs/index.rst index 8121d750..60713db3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,16 +1,16 @@ -🌐 TopoBenchmarkX (TBX) 🍩 +🌐 TopoBenchmark (TB) 🍩 ========================== -.. figure:: https://github.com/pyt-team/TopoBenchmarkX/raw/main/resources/logo.jpeg - :alt: topobenchmarkx +.. figure:: https://github.com/geometric-intelligence/TopoBenchmark/raw/main/resources/logo.jpeg + :alt: topobenchmark :class: with-shadow :width: 1000px -`TopoBenchmarkX` (TBX) is a modular Python library designed to standardize benchmarking and accelerate research in Topological Deep Learning (TDL). -In particular, TBX allows to train and compare the performances of all sorts of Topological Neural Networks (TNNs) across the different topological domains, +`TopoBenchmark` (TB) is a modular Python library designed to standardize benchmarking and accelerate research in Topological Deep Learning (TDL). +In particular, TB allows to train and compare the performances of all sorts of Topological Neural Networks (TNNs) across the different topological domains, where by *topological domain* we refer to a graph, a simplicial complex, a cellular complex, or a hypergraph. -.. figure:: https://github.com/pyt-team/TopoBenchmarkX/raw/main/resources/workflow.jpg +.. figure:: https://github.com/geometric-intelligence/TopoBenchmark/raw/main/resources/workflow.jpg :alt: workflow :class: with-shadow :width: 1000px @@ -29,7 +29,7 @@ Additionally, the library offers the ability to transform, i.e., *lift*, each da ⚙ Neural Networks ----------------- -We list the neural networks trained and evaluated by `TopoBenchmarkX`, organized by the topological domain over which they operate: graph, simplicial complex, cellular complex or hypergraph. Many of these neural networks were originally implemented in `TopoModelX `_. +We list the neural networks trained and evaluated by `TopoBenchmark`, organized by the topological domain over which they operate: graph, simplicial complex, cellular complex or hypergraph. Many of these neural networks were originally implemented in `TopoModelX `_. Graphs @@ -106,7 +106,7 @@ Hypergraphs 🚀 Liftings ----------- -We list the liftings used in `TopoBenchmarkX` to transform datasets. Here, a *lifting* refers to a function that transforms a dataset defined on a topological domain (*e.g.*, on a graph) into the same dataset but supported on a different topological domain (*e.g.*, on a simplicial complex). +We list the liftings used in `TopoBenchmark` to transform datasets. Here, a *lifting* refers to a function that transforms a dataset defined on a topological domain (*e.g.*, on a graph) into the same dataset but supported on a different topological domain (*e.g.*, on a simplicial complex). Graph2Simplicial **************** @@ -237,12 +237,12 @@ Graph2Hypergraph 🔍 References ------------- -To learn more about `TopoBenchmarkX`, we invite you to read the paper: +To learn more about `TopoBenchmark`, we invite you to read the paper: .. code-block:: BibTeX @misc{topobenchmarkx2024, - title={TopoBenchmarkX}, + title={TopoBenchmark}, author={PyT-Team}, year={2024}, eprint={TBD}, @@ -250,12 +250,12 @@ To learn more about `TopoBenchmarkX`, we invite you to read the paper: primaryClass={cs.LG} } -If you find `TopoBenchmarkX` useful, we would appreciate if you cite us! +If you find `TopoBenchmark` useful, we would appreciate if you cite us! 🦾 Getting Started ------------------ -Check out our `tutorials `_ to get started! +Check out our `tutorials `_ to get started! .. toctree:: From 3b43a079bc46f860d094a25f5115ed352f7ded11 Mon Sep 17 00:00:00 2001 From: Nina Miolane Date: Wed, 27 Nov 2024 08:01:31 -0800 Subject: [PATCH 2/4] Jpeg -> Jpg --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 60713db3..429e42ce 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ 🌐 TopoBenchmark (TB) 🍩 ========================== -.. figure:: https://github.com/geometric-intelligence/TopoBenchmark/raw/main/resources/logo.jpeg +.. figure:: https://github.com/geometric-intelligence/TopoBenchmark/raw/main/resources/logo.jpg :alt: topobenchmark :class: with-shadow :width: 1000px From db6c9e91a765eba681cf36d202ebaf19e5d933cc Mon Sep 17 00:00:00 2001 From: Nina Miolane Date: Wed, 27 Nov 2024 08:03:30 -0800 Subject: [PATCH 3/4] Link to tutorials --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index 429e42ce..f68538ef 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -255,7 +255,7 @@ If you find `TopoBenchmark` useful, we would appreciate if you cite us! 🦾 Getting Started ------------------ -Check out our `tutorials `_ to get started! +Check out our `tutorials `_ to get started! .. toctree:: From cc3e9a1373641dd0801131a61ec6fb15e5731019 Mon Sep 17 00:00:00 2001 From: Nina Miolane Date: Wed, 27 Nov 2024 08:04:48 -0800 Subject: [PATCH 4/4] Remove x --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index f68538ef..9d5e3f97 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -241,7 +241,7 @@ To learn more about `TopoBenchmark`, we invite you to read the paper: .. code-block:: BibTeX - @misc{topobenchmarkx2024, + @misc{topobenchmark2024, title={TopoBenchmark}, author={PyT-Team}, year={2024},