Skip to content

Commit

Permalink
improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
AlCatt91 committed May 17, 2024
1 parent 7445d88 commit 1b30997
Show file tree
Hide file tree
Showing 14 changed files with 2,326 additions and 25 deletions.
2 changes: 2 additions & 0 deletions NOTICE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Our dependencies are (see [requirements.txt](requirements.txt)):

We also use additional Python dependencies for development/testing/documentation (see [requirements-dev.txt](requirements-dev.txt)).

The [tutorial notebook](docs/source/notebooks/ogb_biokg_demo.ipynb) make use of the [ogbl-biokg](https://ogb.stanford.edu/docs/linkprop/#ogbl-biokg) dataset, licensed under CC-0;

## Derived work

This directory includes derived work from the following:
Expand Down
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ A Python toolbox to compute topological metrics and statistics for Knowledge Gra

Documentation can be found at https://curly-barnacle-lnejye6.pages.github.io/

For a walkthrough of the main functionalities, we provide an introductory [Jupyter notebook](docs/source/notebooks/ogb_biokg_demo.ipynb).

## Usage

Tested on Ubuntu 20.04, Python >=3.8
Expand All @@ -18,5 +20,5 @@ pip install git+ssh://[email protected]/graphcore-research/kg-topology-toolbox

4\. Import and use:
```python
from kg_topology_toolbox import TopologyToolbox
from kg_topology_toolbox import KGTopologyToolbox
```
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@
"sphinx.ext.intersphinx",
"sphinx.ext.autosectionlabel",
"myst_parser",
"nbsphinx",
]
numpydoc_show_class_members = False
todo_include_todos = True
Expand Down
Binary file added docs/source/images/edge_patterns.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,5 @@ KG Topology Toolbox
:caption: Contents

User guide <user_guide>
notebooks/ogb_biokg_demo
API reference <API_reference>
Loading

0 comments on commit 1b30997

Please sign in to comment.