Skip to content

Commit 1b11ae1

Browse files
committed
Update README
1 parent 4e128ba commit 1b11ae1

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

README.md

Lines changed: 24 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,30 @@ making it suitable for both research and practical applications.
4747
| Local Generalized Matrix LVQ | LGMLVQ (Classifier) | `lgmlvq.py` |
4848

4949

50+
## 📖 Citation Request
51+
52+
Please include these citations if you plan to use this library:
53+
54+
```bibtex
55+
@software{thieu20250515UniLVQ,
56+
author = {Nguyen Van Thieu},
57+
title = {UniLVQ: A Unified Learning Vector Quantization Framework for Supervised Learning Tasks},
58+
month = June,
59+
year = 2025,
60+
doi = {10.6084/m9.figshare.28802435},
61+
url = {https://github.com/thieu1995/UniLVQ}
62+
}
63+
```
64+
5065
## 📦 Installation
5166

52-
You can install the library using `pip` (once published to PyPI):
67+
Install the latest version from PyPI:
5368

5469
```bash
5570
pip install unilvq
5671
```
5772

58-
After installation, you can import `UniLVQ` as any other Python module:
73+
Verify installation:
5974

6075
```sh
6176
$ python
@@ -116,28 +131,14 @@ the repository, create a pull request, or open an issue.
116131
This project is licensed under the GPLv3 License. See the LICENSE file for more details.
117132

118133

119-
## Citation Request
120-
Please include these citations if you plan to use this library:
121-
122-
```bibtex
123-
@software{thieu20250515UniLVQ,
124-
author = {Nguyen Van Thieu},
125-
title = {UniLVQ: A Unified Learning Vector Quantization Framework for Supervised Learning Tasks},
126-
month = may,
127-
year = 2025,
128-
doi = {10.6084/m9.figshare.28802435},
129-
url = {https://github.com/thieu1995/UniLVQ}
130-
}
131-
```
132-
133-
## Official Links
134+
## 📎 Official channels
134135

135-
* Official source code repo: https://github.com/thieu1995/UniLVQ
136-
* Official document: https://unilvq.readthedocs.io/
137-
* Download releases: https://pypi.org/project/unilvq/
138-
* Issue tracker: https://github.com/thieu1995/UniLVQ/issues
139-
* Notable changes log: https://github.com/thieu1995/UniLVQ/blob/master/ChangeLog.md
140-
* Official chat group: https://t.me/+fRVCJGuGJg1mNDg1
136+
* 🔗 [Official source code repository](https://github.com/thieu1995/UniLVQ)
137+
* 📘 [Official document](https://unilvq.readthedocs.io/)
138+
* 📦 [Download releases](https://pypi.org/project/unilvq/)
139+
* 🐞 [Issue tracker](https://github.com/thieu1995/UniLVQ/issues)
140+
* 📝 [Notable changes log](/ChangeLog.md)
141+
* 💬 [Official discussion group](https://t.me/+fRVCJGuGJg1mNDg1)
141142

142143
---
143144

0 commit comments

Comments
 (0)