Skip to content

Commit 94ebfe2

Browse files
committed
Added GH actions. Forgot them. Updated readme.
1 parent f5efe44 commit 94ebfe2

File tree

2 files changed

+40
-5
lines changed

2 files changed

+40
-5
lines changed

.github/workflows/docs.yml

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Build and Deploy Docs
2+
3+
on:
4+
push:
5+
branches: [main, dev]
6+
7+
jobs:
8+
build-and-deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- uses: actions/checkout@v3
12+
13+
- name: Set up Python
14+
uses: actions/setup-python@v4
15+
with:
16+
python-version: '3.9'
17+
18+
- name: Install dependencies
19+
run: |
20+
python -m pip install --upgrade pip
21+
pip install -e .
22+
pip install sphinx sphinx-rtd-theme sphinx-autodoc-typehints
23+
24+
- name: Build docs
25+
run: |
26+
cd docs
27+
make html
28+
29+
- name: Deploy to GitHub Pages
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: ./docs/build/html

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<img src="logo.jpg" alt="TorchSOM_logo" width="350"/>
99
</p>
1010

11-
**TorchSOM** is the official code for
11+
**`TorchSOM`** is the official code for
1212
paper [PAPER ARTICLE AND LINK TO UPDATE](), @CONFERENCE @DATE.
1313
It provides an efficient and scalable implementation of **Self-Organizing Maps (SOMs)** using PyTorch, making it easy to integrate with deep learning workflows while benefiting from GPU acceleration.
1414

@@ -31,10 +31,10 @@ It provides an efficient and scalable implementation of **Self-Organizing Maps (
3131

3232
## Introduction
3333

34-
**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.
34+
**`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.
3535

3636
Also, this **repository is highly documented and commented**, which makes it easy to use, understand, deploy, and which offers endless possibilities for improvements.
37-
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.
37+
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.
3838
- [`iris.ipynb`](notebooks/iris.ipynb): A multiclass classification example.
3939
- [`wine.ipynb`](notebooks/wine.ipynb): Another multiclass classification example.
4040
- [`boston_housing.ipynb`](notebooks/boston_housing.ipynb): A regression example.
@@ -43,6 +43,8 @@ To help you explore and experiment with **TorchSOM**, we provide Jupyter noteboo
4343

4444
If you find this project interesting, we would be grateful for your support by starring ⭐ this [`GitHub repository`](https://github.com/LouisTier/TorchSOM).
4545

46+
Here are some examples of visualizations you can obtain through the use of **`TorchSOM`**.
47+
4648

4749

4850
## Installation
@@ -53,7 +55,7 @@ You can install the package using PyPI (not available yet):
5355
pip install torchsom
5456
```
5557

56-
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**.
58+
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**.
5759

5860
```bash
5961
git clone https://github.com/LouisTier/TorchSOM.git
@@ -77,7 +79,7 @@ Here is the link to the documentation of this library: [https://ccsd.readthedocs
7779

7880
## Citation
7981

80-
If you use TorchSOM in your research or work, please consider citing it using the following entries:
82+
If you use `TorchSOM` in your research or work, please consider citing it using the following entries:
8183

8284
1. **Paper**
8385
```bibtex

0 commit comments

Comments
 (0)