Skip to content

Commit 7f2ef38

Browse files
Dinu23Dinu23
authored andcommitted
readme
1 parent 2aa6208 commit 7f2ef38

File tree

3 files changed

+43
-12
lines changed

3 files changed

+43
-12
lines changed

LISCENSE

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
## License
2+
3+
This application is governed by the __BSD 3-Clause license__.
4+
5+
BSD 3-Clause License
6+
7+
Copyright (c) 2024,
8+
All rights reserved.
9+
10+
Redistribution and use in source and binary forms, with or without
11+
modification, are permitted provided that the following conditions are met:
12+
13+
* Redistributions of source code must retain the above copyright notice, this
14+
list of conditions and the following disclaimer.
15+
16+
* Redistributions in binary form must reproduce the above copyright notice,
17+
this list of conditions and the following disclaimer in the documentation
18+
and/or other materials provided with the distribution.
19+
20+
* Neither the name of the copyright holder nor the names of its
21+
contributors may be used to endorse or promote products derived from
22+
this software without specific prior written permission.
23+
24+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
27+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
28+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
30+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
31+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
32+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,7 @@ As part of the IOHprofiler framework, IOHClustering is under active development.
1818
The minimum supported Python version is 3.10. Install IOHClustering via pip and git:
1919

2020
```bash
21-
git clone https://github.com/IOHprofiler/IOHClustering.git
22-
cd IOHClustering
23-
pip install .
21+
pip install iohclustering
2422
```
2523

2624
## Basic Usage
@@ -75,14 +73,14 @@ for problem in problems.keys():
7573

7674

7775
## Tutorials
78-
### Tutorials
7976

8077
Explore the following Jupyter notebooks for step-by-step tutorials on using **IOHClustering**:
8178
1. [Custom Dataset and Random Search Tutorial](https://github.com/IOHprofiler/IOHClustering/blob/main/tutorials/custom_dataset_random_search.ipynb): Learn how to define clustering problems with your own datasets and explore solutions using random search.
8279
2. [Custom Metric and Random Search Tutorial](https://github.com/IOHprofiler/IOHClustering/blob/main/tutorials/custom_clustering_metric.ipynb): Understand how to define custom clustering metrics and solve clustering problems with random search.
8380

8481
## License
8582

83+
This project is licensed under a standard BSD-3 clause License. See the LICENSE file for details.
8684

8785

8886
## Acknowledgments

tutorials/custom_clustering_metric.ipynb

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
},
1313
{
1414
"cell_type": "code",
15-
"execution_count": 16,
15+
"execution_count": 24,
1616
"id": "d858903c",
1717
"metadata": {},
1818
"outputs": [],
@@ -36,7 +36,7 @@
3636
},
3737
{
3838
"cell_type": "code",
39-
"execution_count": 17,
39+
"execution_count": 25,
4040
"id": "2f098aac",
4141
"metadata": {},
4242
"outputs": [
@@ -68,7 +68,7 @@
6868
},
6969
{
7070
"cell_type": "code",
71-
"execution_count": 18,
71+
"execution_count": 26,
7272
"id": "c51d35b4",
7373
"metadata": {},
7474
"outputs": [],
@@ -121,7 +121,7 @@
121121
},
122122
{
123123
"cell_type": "code",
124-
"execution_count": 19,
124+
"execution_count": 27,
125125
"id": "0ef973fe",
126126
"metadata": {},
127127
"outputs": [],
@@ -149,7 +149,7 @@
149149
},
150150
{
151151
"cell_type": "code",
152-
"execution_count": 20,
152+
"execution_count": 28,
153153
"id": "a05bc3ca",
154154
"metadata": {},
155155
"outputs": [],
@@ -179,7 +179,7 @@
179179
},
180180
{
181181
"cell_type": "code",
182-
"execution_count": 21,
182+
"execution_count": 29,
183183
"id": "e236402e",
184184
"metadata": {},
185185
"outputs": [],
@@ -204,7 +204,7 @@
204204
},
205205
{
206206
"cell_type": "code",
207-
"execution_count": 22,
207+
"execution_count": 30,
208208
"id": "3d518238",
209209
"metadata": {},
210210
"outputs": [],
@@ -228,7 +228,7 @@
228228
},
229229
{
230230
"cell_type": "code",
231-
"execution_count": 23,
231+
"execution_count": 31,
232232
"id": "47034443",
233233
"metadata": {},
234234
"outputs": [],

0 commit comments

Comments
 (0)