Skip to content

added self organising maps algorithm in the machine learning section. #6877

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Oct 12, 2022
73 changes: 73 additions & 0 deletions machine_learning/self_organizing_map.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
"""
https://en.wikipedia.org/wiki/Self-organizing_map
"""
import math


class SelfOrganizingMap:
def get_winner(self, weights: list[list[float]], sample: list[int]) -> int:
"""
Compute the winning vector by Euclidean distance

>>> SelfOrganizingMap().get_winner([[1, 2, 3], [4, 5, 6]], [1, 2, 3])
1
"""
d0 = 0.0
d1 = 0.0
for i in range(len(sample)):
d0 += math.pow((sample[i] - weights[0][i]), 2)
d1 += math.pow((sample[i] - weights[1][i]), 2)
return 0 if d0 > d1 else 1
return 0

def update(
self, weights: list[list[int | float]], sample: list[int], j: int, alpha: float

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please provide descriptive name for the parameter: j

) -> list[list[int | float]]:
"""
Update the winning vector.

>>> SelfOrganizingMap().update([[1, 2, 3], [4, 5, 6]], [1, 2, 3], 1, 0.1)
[[1, 2, 3], [3.7, 4.7, 6]]
"""
for i in range(len(weights)):
weights[j][i] += alpha * (sample[i] - weights[j][i])
return weights


# Driver code
def main() -> None:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As there is no test file in this pull request nor any test function or class in the file machine_learning/self_organizing_map.py, please provide doctest for the function main

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@dhruvmanila Does the main() function really need doctests?

# Training Examples ( m, n )
training_samples = [[1, 1, 0, 0], [0, 0, 0, 1], [1, 0, 0, 0], [0, 0, 1, 1]]

# weight initialization ( n, C )
weights = [[0.2, 0.6, 0.5, 0.9], [0.8, 0.4, 0.7, 0.3]]

# training
self_organizing_map = SelfOrganizingMap()
epochs = 3
alpha = 0.5

for i in range(epochs):
for j in range(len(training_samples)):

# training sample
sample = training_samples[j]

# Compute the winning vector
winner = self_organizing_map.get_winner(weights, sample)

# Update the winning vector
weights = self_organizing_map.update(weights, sample, winner, alpha)

# classify test sample
sample = [0, 0, 0, 1]
winner = self_organizing_map.get_winner(weights, sample)

# results
print(f"Clusters that the test sample belongs to : {winner}")
print(f"Weights that have been trained : {weights}")


# running the main() function
if __name__ == "__main__":
main()