You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-18Lines changed: 7 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,7 +37,7 @@ It provides an efficient and scalable implementation of **Self-Organizing Maps (
37
37
**TorchSOM** is a PyTorch-based library for training Self-Organizing Maps (SOMs), a type of unsupervised learning algorithm used for clustering and dimensionality reduction. Designed for scalability and ease of use, this implementation is optimized for large-scale data.
38
38
39
39
Also, this **repository is highly documented and commented**, which makes it easy to use, understand, deploy, and which offers endless possibilities for improvements.
40
-
To help you explore and experiment with **TorchSOM**, we provide Jupyter notebooks in the [`notebooks/`](notebooks) directory. There are multiples datasets and the corresponding results respectively in the [`data/`](data) and [`notebooks/results/`](notebooks/results) directories.
40
+
To help you explore and experiment with **TorchSOM**, we provide Jupyter notebooks in the [`notebooks/`](notebooks) directory. There are multiples datasets and the corresponding results respectively in the [`data/`](data) and [`results/`](notebooks/results) directories.
41
41
-[`iris.ipynb`](notebooks/iris.ipynb): A multiclass classification example.
42
42
-[`wine.ipynb`](notebooks/wine.ipynb): Another multiclass classification example.
43
43
-[`boston_housing.ipynb`](notebooks/boston_housing.ipynb): A regression example.
@@ -50,37 +50,26 @@ If you find this project interesting, we would be grateful for your support by s
50
50
51
51
## Installation
52
52
53
-
You can install the package using pip following this command (not available yet):
53
+
You can install the package using PyPI (not available yet):
54
54
55
55
```bash
56
-
pip install torchsom# Requires the dependencies from the requirements.txt file
56
+
pip install torchsom
57
57
```
58
58
59
-
If you want to use the latest version, or if you prefer the command line interface, you can use it locally by cloning or forking this repository to your local machine. TorchSOM requires a recent version of Python, preferably **3.11 or higher**.
59
+
If you want to use the latest version, or if you prefer the command line interface, you can use it locally by cloning or forking this repository to your local machine. TorchSOM requires a recent version of Python, preferably **3.9 or higher**.
60
60
61
61
```bash
62
-
git clone https://github.com/LouisTier/TorchSOM.git # Retrieve the GitHub repository
If you want to develop the package and run the notebooks after cloning the repository, make sure you have the required dependencies installed before using it:
66
66
67
67
```bash
68
-
python3.11 -m venv .torchsom_env # Create a virtual environment
68
+
python3.9 -m venv .torchsom_env # Create a virtual environment
69
69
source .torchsom_env/bin/activate # Activate the environment
70
-
pip install -r dev-requirements.txt # Install the required dependencies
71
-
pip install -e .# Install the torchsom package
70
+
pip install -e '.[dev]'# Install the required dependencies
72
71
```
73
72
74
-
You can also run:
75
-
76
-
```bash
77
-
pip install .# Install the required dependencies from setup.py
78
-
pip install .[dev] # Install the required dependencies from setup.py and "extras_require"
79
-
```
80
-
81
-
[`requirements.txt`](requirements.txt) stands for the dependencies that are required when importing `torchsom`.
82
-
[`dev-requirements.txt`](dev-requirements.txt) stands for the dependencies that are required when cloning the GitHub repository and developing the `torchsom` package or running `notebooks`.
0 commit comments