Diff of /README.md [000000] .. [6673ef]

Switch to unified view

a b/README.md
1
# Cardiac MRI Segmentation
2
3
![build status](https://travis-ci.org/chuckyee/cardiac-segmentation.svg?branch=master)
4
5
This repository contains code and models to identify the right ventricle in
6
cardiac MRI images. The
7
[project](http://ai-on.org/projects/cardiac-mri-segmentation.html) is one of
8
the open calls for research from Francois Chollet's [AI Open
9
Network](http://ai-on.org/).
10
11
For the problem description, models and results, please see the blog post
12
[here](https://chuckyee.github.io/cardiac-segmentation/).
13
14
## Installation
15
16
The main code is written as a Python package named `rvseg'. After cloning this
17
repository to your machine, install with:
18
19
```bash
20
cd cloned/path
21
pip install .
22
```
23
24
You should then be able to use the package in Python:
25
26
```python
27
import matplotlib.pyplot as plt
28
from rvseg import patient, models
29
30
p = patient.PatientData("RVSC-data/TrainingSet/patient01")
31
# Explore p.images, p.endocardium_masks, etc.
32
```
33
34
## Running models
35
36
Scripts for model training and evaluation are located under /scripts/.
37
38
```bash
39
python -u scripts/train.py defaults.config
40
```
41
42
Note: this package is written with the Tensorflow backend in mind -- (batch,
43
height, width, channels) ordered is assumed and is not portable to Theano.