Skip to content

Commit

Permalink
Add link to paper, add sentences describing the project, resolves #5
Browse files Browse the repository at this point in the history
  • Loading branch information
lkeegan committed Jan 23, 2025
1 parent a77500a commit 97d76de
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 3 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,12 @@
[![ci](https://github.com/ssciwr/QHCC/actions/workflows/ci.yml/badge.svg)](https://github.com/ssciwr/QHCC/actions/workflows/ci.yml)

Source code and example notebooks for the [Q-HCC website](https://ssciwr.github.io/QHCC).

## To build the website locally

```bash
pip install mkdocs-material
mkdocs serve
```

The website will then be served locally at http://127.0.0.1:8000/QHCC, and will be updated if any of the markdown files are edited.
2 changes: 1 addition & 1 deletion docs/data.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Data

Introduction to the provided datasets.
Q-HCC - Quality-assured data set for hepatocellular carcinoma.

## heiData

Expand Down
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
# Welcome to Q-HCC

Some text about what this is...
The objective of this project is to provide a baseline for performing multi-modal data classification on a novel open multimodal dataset of hepatocellular carcinoma (HCC).

To learn more about the models and how to run them yourself, see the [models](models.md) page.

To learn more about the data and how to download it, see the [data](data.md) page.

## Quickstart

Expand Down
4 changes: 3 additions & 1 deletion docs/models.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Models

Example models and data are provided at [github.com/ZhaoWenzhao/QHCC](https://github.com/ZhaoWenzhao/QHCC).
A paper draft is available at [arXiv:2501.11535](https://arxiv.org/abs/2501.11535). The objective of this paper is to provide a baseline for performing multi-modal data classification on a novel open multimodal dataset of hepatocellular carcinoma (HCC), which includes both image data (contrast-enhanced CT and MRI images) and tabular data (the clinical laboratory test data as well as case report forms).

Example models and pre-processed data are provided at [github.com/ZhaoWenzhao/QHCC](https://github.com/ZhaoWenzhao/QHCC).

In order to run the provided example scripts, you will need to use Python 3.8 or 3.9, and install the required Python libraries.

Expand Down

0 comments on commit 97d76de

Please sign in to comment.