Skip to content

Commit 7e2034c

Browse files
authored
Merge pull request #3 from amathislab/Readme
Readme updates
2 parents ba09c91 + 631aaaf commit 7e2034c

File tree

1 file changed

+14
-6
lines changed

1 file changed

+14
-6
lines changed

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,14 @@
1515
DLC2Action is an action segmentation package that makes running and tracking experiments easy.
1616

1717
## 🛠️ Installation
18+
1819
You can simply install DLC2Action by typing:
20+
1921
```
2022
pip install dlc2action
2123
```
2224

23-
Or you can install DLC2Action for development by running this in your terminal.
25+
Or you can install the latest DLC2Action for development by running this in your terminal:
2426
```
2527
git clone https://github.com/amathislab/DLC2Action
2628
cd DLC2Action
@@ -30,7 +32,9 @@ python -m pip install .
3032
```
3133

3234
## 📖 Features
35+
3336
The functionality of DLC2Action includes:
37+
- a [GUI for annotation, visualization and active learning](https://github.com/amathislab/dlc2action_annotation)
3438
- compiling and updating project-specific configuration files,
3539
- filling in the configuration dictionaries automatically whenever possible,
3640
- saving training parameters and results,
@@ -45,8 +49,10 @@ The functionality of DLC2Action includes:
4549
and more.
4650

4751
## ⚡ A quick example
52+
4853
You can start a new project, run an experiment, visualize it and use the trained model to make a prediction
49-
in a few lines of code.
54+
in a few lines of code:
55+
5056
```python
5157
project = Project("project", data_type="dlc_track", annotation_type="csv")
5258
project.update_parameters(...)
@@ -58,11 +64,13 @@ project.run_prediction("prediction", episode_names=["episode"], data_path="/path
5864

5965
## 📊 Benchmarks
6066

61-
We provide standardized benchmarks on action segmentation to help you evaluate DLC2Action's performance. Check out the [benchmarks section](examples/benchmarks/README.md) for detailed results and comparisons.
67+
We provide standardize benchmarks on action segmentation to help you evaluate DLC2Action's performance.
68+
Check out the [benchmarks section](examples/benchmarks/README.md) for detailed results and comparisons.
6269

63-
## 📚 How to get more information ?
70+
## 📚 How to get more information?
6471

65-
Check out the [examples](/examples) or [read the documentation](html_docs/dlc2action/index.html) for a taste of what else you can do.
72+
Check out the [examples](/examples) or [read the documentation](html_docs/dlc2action/index.html)
73+
for a taste of what else you can do.
6674

6775
## 🙏 Acknowledgments
6876

@@ -76,4 +84,4 @@ Note that the software is provided "as is", without warranty of any kind, expres
7684

7785
## 📑 Reference
7886

79-
Stay tuned for our first publication -- any feedback on this release candidate for version 1 is welcome. Thanks for using DLC2Action. Please reach out if you want to collaborate!
87+
Stay tuned for our first publication -- any feedback on this beta release is welcome at this time. Thanks for using DLC2Action. Please reach out if you want to collaborate!

0 commit comments

Comments
 (0)