Skip to content

Commit 179805b

Browse files
LouisTierLouisTier
authored
Merge pull request #2 from michelin/dev
Merging dev to main: Fixed package presentation.
2 parents 0e80ae1 + 32e1c83 commit 179805b

File tree

15 files changed

+809
-221
lines changed

15 files changed

+809
-221
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 '.[dev]'
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

‎.github/workflows/run-test.yml‎

Lines changed: 0 additions & 41 deletions
This file was deleted.

‎CITATION.cff‎

Lines changed: 34 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,57 +1,36 @@
1-
cff-version: 1.2.0
2-
3-
message: "If you use this software, please cite it as below."
4-
5-
title: "TorchSOM: A Scalable PyTorch-Compatible Library for Self-Organizing Maps"
6-
abstract: "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."
7-
keywords:
8-
- "Self-Organizing Map (SOM)"
9-
- "PyTorch"
10-
- "Machine Learning"
11-
- "Unsupervised Learning"
12-
- "Dimensionality Reduction"
13-
- "Clustering"
14-
- "Data Visualization"
15-
16-
repository: "https://github.com/LouisTier/TorchSOM"
17-
license: "Apache-2.0"
18-
year: 2025
1+
# This CITATION.cff file was generated with cffinit.
2+
# Visit https://bit.ly/cffinit to generate yours today!
193

4+
cff-version: 1.2.0
5+
title: >-
6+
TorchSOM: A Scalable PyTorch-Compatible Library for
7+
Self-Organizing Maps
8+
message: 'If you use this software, please cite both the article and the software itself.'
9+
type: software
2010
authors:
21-
- family-names: "Berthier"
22-
given-names: "Louis"
23-
orcid: "https://orcid.org/0009-0009-9654-2448"
24-
affiliation:
25-
- "Michelin, France"
26-
- "Centre de Mathématiques Appliquées, Ecole Polytechnique, France"
27-
email: "louis_tier@outlook.com"
28-
website: "https://louistier.github.io/"
29-
30-
references:
31-
- type: software
32-
title: "TorchSOM: A Scalable PyTorch-Compatible Library for Self-Organizing Maps"
33-
authors:
34-
- family-names: "Berthier"
35-
given-names: "Louis"
36-
version: "1.0.0"
37-
date-released: "2025-05-20"
38-
url: "https://github.com/LouisTier/TorchSOM"
39-
license: "Apache-2.0"
40-
year: 2025
41-
42-
# license:
43-
# type: "Apache-2.0"
44-
# url: "https://opensource.org/licenses/Apache-2.0"
45-
# file: LICENSE
46-
47-
# preferred-citation:
48-
# type: inproceedings
49-
# title: "TorchSOM: A Scalable PyTorch-Compatible Library for Self-Organizing Maps"
50-
# authors:
51-
# - family-names: "Berthier"
52-
# given-names: "Louis"
53-
# booktitle: "Proceedings of the XXth CONFERENCE NAME"
54-
# year: "2025"
55-
# url: "https://arxiv.org/abs/XXXXX" # If available
56-
# doi: "10.XXXX/XXXXX" # If available
57-
11+
- given-names: Louis
12+
family-names: Berthier
13+
email: louis-desire-romeo.berthier@michelin.com
14+
affiliation: 'Manufacture Française des Pneumatiques Michelin; Centre de Mathématiques Appliquées (CMAP), Ecole Polytechnique'
15+
orcid: 'https://orcid.org/0009-0009-9654-2448'
16+
website: 'https://louistier.github.io/'
17+
repository-code: 'https://github.com/michelin/TorchSOM'
18+
url: 'https://opensource.michelin.io/TorchSOM'
19+
abstract: >-
20+
TorchSOM is a PyTorch-based library for training
21+
Self-Organizing Maps (SOMs), a type of unsupervised
22+
learning algorithm used for dimensionality reduction,
23+
visualization, and just-in-time learning (JITL). Designed
24+
for scalability and ease of use, this implementation is
25+
optimized for large-scale data.
26+
keywords:
27+
- Self-Organizing Map (SOM)
28+
- PyTorch
29+
- Machine Learning
30+
- Unsupervised Learning
31+
- Dimensionality Reduction
32+
- Just-in-Time Learning (JITL)
33+
- Data Visualization
34+
license: Apache-2.0
35+
version: 1.0.0
36+
date-released: '2025-05-20'

‎CODE_OF_CONDUCT.md‎

Lines changed: 125 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,131 @@
11
# Code of Conduct
22

3-
We are a community based on openness, as well as friendly and didactic discussions.
3+
## Our Pledge
44

5-
We aspire to treat everybody equally, and value their contributions.
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
611

7-
Decisions are made based on technical merit and consensus.
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
814

9-
Code is not the only way to help the project. Reviewing pull requests, answering questions to help others on mailing lists or issues, organizing and teaching tutorials, working on the website, improving the documentation, are all priceless contributions.
15+
## Our Standards
1016

11-
We abide by the principles of openness, respect, and consideration of others of
12-
the Python Software Foundation:
13-
[https://www.python.org/psf/codeofconduct/](https://www.python.org/psf/codeofconduct/)
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official email address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement available in [opensource.michelin.io](https://opensource.michelin.io/) contact.
63+
All complaints will be reviewed and investigated promptly and fairly.
64+
65+
All community leaders are obligated to respect the privacy and security of the
66+
reporter of any incident.
67+
68+
## Enforcement Guidelines
69+
70+
Community leaders will follow these Community Impact Guidelines in determining
71+
the consequences for any action they deem in violation of this Code of Conduct:
72+
73+
### 1. Correction
74+
75+
**Community Impact**: Use of inappropriate language or other behavior deemed
76+
unprofessional or unwelcome in the community.
77+
78+
**Consequence**: A private, written warning from community leaders, providing
79+
clarity around the nature of the violation and an explanation of why the
80+
behavior was inappropriate. A public apology may be requested.
81+
82+
### 2. Warning
83+
84+
**Community Impact**: A violation through a single incident or series of
85+
actions.
86+
87+
**Consequence**: A warning with consequences for continued behavior. No
88+
interaction with the people involved, including unsolicited interaction with
89+
those enforcing the Code of Conduct, for a specified period of time. This
90+
includes avoiding interactions in community spaces as well as external channels
91+
like social media. Violating these terms may lead to a temporary or permanent
92+
ban.
93+
94+
### 3. Temporary Ban
95+
96+
**Community Impact**: A serious violation of community standards, including
97+
sustained inappropriate behavior.
98+
99+
**Consequence**: A temporary ban from any sort of interaction or public
100+
communication with the community for a specified period of time. No public or
101+
private interaction with the people involved, including unsolicited interaction
102+
with those enforcing the Code of Conduct, is allowed during this period.
103+
Violating these terms may lead to a permanent ban.
104+
105+
### 4. Permanent Ban
106+
107+
**Community Impact**: Demonstrating a pattern of violation of community
108+
standards, including sustained inappropriate behavior, harassment of an
109+
individual, or aggression toward or disparagement of classes of individuals.
110+
111+
**Consequence**: A permanent ban from any sort of public interaction within the
112+
community.
113+
114+
## Attribution
115+
116+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
117+
version 2.1, available at
118+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
119+
120+
Community Impact Guidelines were inspired by
121+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
122+
123+
For answers to common questions about this code of conduct, see the FAQ at
124+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
125+
[https://www.contributor-covenant.org/translations][translations].
126+
127+
[homepage]: https://www.contributor-covenant.org
128+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
129+
[Mozilla CoC]: https://github.com/mozilla/diversity
130+
[FAQ]: https://www.contributor-covenant.org/faq
131+
[translations]: https://www.contributor-covenant.org/translations

0 commit comments

Comments
 (0)