Skip to content

Commit 928e677

Browse files
Simplified README
1 parent e7c8421 commit 928e677

File tree

1 file changed

+8
-10
lines changed

1 file changed

+8
-10
lines changed

README.md

+8-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
1-
# MANTRADataset
1+
# MANTRA: Manifold Triangulations Assembly
22

3-
# Structure
3+
## Getting the Dataset
44

5-
**mantra** Contains the code for the dataset definition for PyTorch Geometric.
6-
7-
**dataprocessing** Contains the code to publish the dataset to a github release, including the preprocessing scripts. NOTE: We might want to move this to another folder, or rename.
8-
9-
## Dataset
10-
11-
The raw datasets, consisting of the 2 and 3 manifolds with up to 10 vertices, can be downloaded under releases. A pytorch geometric wrapper for the dataset is installable via the following command.
5+
The raw datasets, consisting of the 2 and 3 manifolds with up to 10
6+
vertices, can be downloaded under releases. A pytorch geometric wrapper
7+
for the dataset is installable via the following command.
128

139
```{python}
1410
pip install "git+https://github.com/aidos-lab/MANTRADataset/#subdirectory=mantra"
@@ -22,4 +18,6 @@ from mantra.simplicial import SimplicialDataset
2218
dataset = SimplicialDataset(root="./data", manifold="2")
2319
```
2420

25-
**Warning** Since the repository is private, the dataset can not download the data from the github release due to access restrictions. Hence one has to manually download the "2_manifolds.json.gz" or "3_manifolds.json.gz" to the raw folder for the code to run correctly.
21+
## Folder Structure
22+
23+
## Design Decisions

0 commit comments

Comments
 (0)