Skip to content

Commit b81d264

Browse files
committed
yet another readme file commit
1 parent b221726 commit b81d264

File tree

4 files changed

+30
-6
lines changed

4 files changed

+30
-6
lines changed

README.md

+30-6
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66

77
<p align="justify">
8-
a Numpy vectorized implementation written in Python of some of the fuzzy clustering algorithms which includes the following:
8+
a Numpy vectorized implementation written in Python of some of the fuzzy clustering algorithms, it includes the following:
99
</p>
1010

1111
<ul>
@@ -38,23 +38,47 @@ in non-fuzzy clustering, data is divided into distinct clusters, where each data
3838

3939

4040
<p> before installing the package its highly recommended that you create a virtual environment, there are many tools which are capable of that, such as conda , venv ...etc.
41-
here is an example of doing so using virtualenv: </p>
41+
here is an example of doing so using virtualenv: </p>
4242

43-
<p> first you install virtualenv </p>
43+
<p> First you install virtualenv </p>
4444
<pre><code>$ pip install virtualenv </code></pre>
4545

46-
<p> and then create a folder where you can create your environment and cd into it and then execute the following command: </p>
46+
<p> Then create a folder where you can create your environment and cd into it and then execute the following command: </p>
4747
<pre><code>$ virtualenv env </code></pre>
4848

49-
<p> now activate the environment </p>
49+
<p> Now activate the environment </p>
5050
<pre><code>$ \env\Scripts\activate.bat </code></pre>
5151

52-
<p> to Install the Package from PyPi, install pip then run the following code: </p>
52+
<p> To Install the Package from PyPi, install pip then run the following code: </p>
5353
<pre><code>$ pip install Fuzzy_Clustering </code></pre>
5454

5555

5656
<p> OR if you want to also include dependencies which are necessery for running the examples, you must run the following:(Recommended) </p>
5757
<pre><code>$ pip install Fuzzy_Clustering[examples] </code></pre>
5858

59+
<h2 id="Usage"> :pencil: Usage</h2>
60+
61+
<p> You can clone the repository and check into the examples folder,
62+
it provides two examples.</p>
63+
64+
<p> The first example demonstrates how one can use fuzzy clustering to segment the color values within an into several distinct groups,
65+
in the example below,Fuzzy C-Means was used with a parameterof 10 clusters. </p>
66+
67+
<pre><code>$ python fuzzy_image_segmentation.py </code></pre>
68+
69+
70+
<p align="center">
71+
<img src="res/segmentation.JPG" alt="segmentation results" height="282px" width="550px">
72+
</p>
73+
74+
<p> The second example demonstrates the results of running the algorithm on a set of random scattered data points,
75+
the algorithm was run several times with a varying number of clusters parameter.</p>
76+
77+
<pre><code>$ python random_data_clustering.py </code></pre>
78+
79+
<p align="center">
80+
<img src="res/random_clustering.JPG" alt="random points clustering" height="282px" width="550px">
81+
</p>
82+
5983

6084

res/oarsman.jpeg

49.8 KB
Loading

res/random_clustering.JPG

111 KB
Loading

res/segmentation.JPG

35.7 KB
Loading

0 commit comments

Comments
 (0)