Skip to content

Commit b221726

Browse files
committed
another change to the readme file
1 parent 58e1c57 commit b221726

File tree

1 file changed

+30
-5
lines changed

1 file changed

+30
-5
lines changed

README.md

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,18 +9,18 @@
99
</p>
1010

1111
<ul>
12-
<li> ➤ Fuzzy C-Means: </li>
13-
<li> ➤ Gustafason-Kessel: </li>
12+
<li> ➤ Fuzzy C-Means </li>
13+
<li> ➤ Gustafason-Kessel </li>
1414
</ul>
1515

16-
<h3> Theoritical Generlized Description of the Fuzzy Algorithm </h3>
16+
<h3> Theoritical General Description of the Fuzzy Algorithm </h3>
1717

18-
<p> Fuzzy Clustering is a form of clustering in which each data point can belong to more than one cluster it involves assigning data points to clusters such that items in the same cluster are as similar as possible while items belonging to different clusters are as dissimiliar as possible.Clusters are identified via similarity measures.Different similarity measures may be used, in this implementation the euclidean distance and Mahalanobis distance are used.
18+
<p> Fuzzy Clustering is a form of clustering in which each data point can belong to more than one cluster it involves assigning data points to clusters such that items in the same cluster are as similar as possible while items belonging to different clusters are as dissimiliar as possible. Clusters are identified via similarity measures. Different similarity measures may be used, in this implementation the euclidean distance and Mahalanobis distance are used.
1919
</p>
2020

2121
<h3> Comparison to hard Clustering </h3>
2222
<p>
23-
in non-fuzzy clustering, data is divided into distinct clusters, where each data point can only belong to exactly one cluster.In Fuzzy clustering can potentially belong to multiple clusters.
23+
in non-fuzzy clustering, data is divided into distinct clusters, where each data point can only belong to exactly one cluster. In Fuzzy clustering, data points can potentially belong to multiple clusters.
2424
</p>
2525

2626
<h3> The Algorithm: </h3>
@@ -33,3 +33,28 @@ in non-fuzzy clustering, data is divided into distinct clusters, where each data
3333
<li> Repeat step number 2 Until Convergence or reaching maximum number of iterations allowed</li>
3434
</ol>
3535

36+
37+
<h2 id="How to Install"> :floppy_disk: How to Install </h2>
38+
39+
40+
<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>
42+
43+
<p> first you install virtualenv </p>
44+
<pre><code>$ pip install virtualenv </code></pre>
45+
46+
<p> and then create a folder where you can create your environment and cd into it and then execute the following command: </p>
47+
<pre><code>$ virtualenv env </code></pre>
48+
49+
<p> now activate the environment </p>
50+
<pre><code>$ \env\Scripts\activate.bat </code></pre>
51+
52+
<p> to Install the Package from PyPi, install pip then run the following code: </p>
53+
<pre><code>$ pip install Fuzzy_Clustering </code></pre>
54+
55+
56+
<p> OR if you want to also include dependencies which are necessery for running the examples, you must run the following:(Recommended) </p>
57+
<pre><code>$ pip install Fuzzy_Clustering[examples] </code></pre>
58+
59+
60+

0 commit comments

Comments
 (0)