Diff of /README.md [000000] .. [e50482]

Switch to unified view

a b/README.md
1
# Cardiac Segmentation ACDC
2
3
Deep learning-based cardiac segmentation using PyTorch, MONAI, and U-Net models.
4
5
## About
6
This project leverages deep learning models for cardiac segmentation, particularly for the ACDC dataset. The goal is to segment the heart's anatomical structures to aid in medical analysis.
7
8
### Features:
9
- **2D and 3D U-Net models** for segmentation.
10
- **Attention mechanisms** for improved segmentation accuracy.
11
- **Support for both 2D and 3D datasets** (using MONAI and PyTorch).
12
13
## Installation
14
15
### Prerequisites:
16
- Python 3.x
17
- PyTorch
18
- MONAI
19
- other Python dependencies from `requirements.txt`
20
21
### Setup:
22
1. Clone the repository:
23
    ```bash
24
    git clone https://github.com/arkanandi/Cardiac_Segmentation_ACDC.git
25
    cd Cardiac_Segmentation_ACDC
26
    ```
27
28
2. Install the required Python libraries:
29
    ```bash
30
    pip install -r requirements.txt
31
    ```
32
33
3. Download the ACDC dataset and place it in the appropriate folder (see the dataset instructions in the repository for details).
34
35
4. To train the model, run:
36
    ```bash
37
    python train_2d.py
38
    # or
39
    python train_3d.py
40
    ```
41
42
5. To make predictions:
43
    ```bash
44
    python predict_2d.py
45
    # or
46
    python predict_3d.py
47
    ```
48
49
## Usage
50
51
Once you have trained the model, you can use it to predict cardiac structures on new datasets.
52
53
## Contributing
54
55
Feel free to fork the repository and submit pull requests. Issues and suggestions are always welcome.
56
57
1. Fork this repository.
58
2. Clone your fork:
59
    ```bash
60
    git clone https://github.com/your-username/Cardiac_Segmentation_ACDC.git
61
    ```
62
3. Create a new branch:
63
    ```bash
64
    git checkout -b feature-name
65
    ```
66
4. Make changes and commit:
67
    ```bash
68
    git commit -am 'Add new feature'
69
    ```
70
5. Push to your fork:
71
    ```bash
72
    git push origin feature-name
73
    ```
74
75
## License
76
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.