Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,11 +87,27 @@ More details: https://pytorch-geometric.readthedocs.io/en/latest/notes/installat

### 3) Pre‑commit hooks

```bash
pre-commit install
```
This repository uses pre-commit hooks to ensure code quality and consistency. To set up pre-commit hooks locally, follow these steps:

1. Install the `pre-commit` package if you haven't already:

```bash
pip install pre-commit
```

2. Install the hooks defined in the `.pre-commit-config.yaml` file:

Then open terminal and navigate to the repository folder, and you can use `pre-commit run --all` to check all files.
```bash
pre-commit install
```

3. Run the hooks manually on all files (optional):

```bash
pre-commit run --all
```

Pre-commit hooks will now run automatically on every commit to check and format your code.

### 4) Run tests

Expand All @@ -103,6 +119,10 @@ pytest

Example data can be downloaded from [this Dropbox folder](https://www.dropbox.com/scl/fo/8xjlsri0zcov20v8xsyxa/AOMpquFinnQnp287lT5hxJM?rlkey=1h1sm3wxd4s1oeygludri6hr6&st=cg0qdhic&dl=0). No Dropbox account is required to access the files.

## Sample `Dataset` and `DataLoader` design

![sample-dataloader-design.jpg](./imgs/sample-dataloader-design.jpg)

## Notes

- The project restricts Python versions to 3.10–3.12 as specified in `.python-version` and `pyproject.toml`.
Expand Down
Binary file added imgs/sample-dataloader-design.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.