Skip to content

Commit

Permalink
Merge pull request #120 from geometric-intelligence/ninamiolane-docs-…
Browse files Browse the repository at this point in the history
…cosmetics

Clean up landing page of documentation website
  • Loading branch information
ninamiolane authored Nov 27, 2024
2 parents f88ba41 + cc3e9a1 commit f44781e
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
26 changes: 13 additions & 13 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -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.jpg
: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
Expand All @@ -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 <https://github.com/pyt-team/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 <https://github.com/pyt-team/TopoModelX>`_.


Graphs
Expand Down Expand Up @@ -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
****************
Expand Down Expand Up @@ -237,25 +237,25 @@ 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},
@misc{topobenchmark2024,
title={TopoBenchmark},
author={PyT-Team},
year={2024},
eprint={TBD},
archivePrefix={arXiv},
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 <https://github.com/pyt-team/TopoBenchmarkX/tree/main/tutorials>`_ to get started!
Check out our `tutorials <https://github.com/geometric-intelligence/TopoBenchmark/tree/main/tutorials>`_ to get started!


.. toctree::
Expand Down

0 comments on commit f44781e

Please sign in to comment.