Skip to content

Commit f90f0a7

Browse files
committed
update wrong hots argument in doc
1 parent 3976b3b commit f90f0a7

File tree

3 files changed

+6
-11
lines changed

3 files changed

+6
-11
lines changed

Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ doc:
1818
.PHONY: done
1919
done:
2020
@ echo "Installation finished succesfully. \
21-
Run 'hots path/to/data_folder' to start the application or \
21+
Run 'hots path/to/config/file' to start the application or \
2222
'hots --help' for command description"
2323

2424

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Before running the application, you need to configure the Kafka broker informati
5454
The application can be used simply by running :
5555

5656
```bash
57-
hots /path/to/data/folder
57+
hots /path/to/config/file
5858
```
5959

6060
Make sure to activate the virtual environment before running HOTS with :
@@ -66,7 +66,7 @@ source venv/bin/activate
6666
Some parameters can be defined with the `hots` command, such as :
6767
* `k` : the number of clusters used in clustering ;
6868
* `tau` : the window size during the loop process ;
69-
* `param` : a specific parameter file to use.
69+
* `time_limit` : the maximum time to run the application.
7070

7171
All the CLI options are found running the `help` option :
7272
```bash
@@ -77,7 +77,7 @@ More parameters can be defined through a `.JSON` file, for which an example is p
7777

7878
Note that a test data is provided within the package, so you can easily test the installation with :
7979
```bash
80-
hots /tests/data/generated_7
80+
hots /tests/data/thesis_ex_10/params.json
8181
```
8282

8383
### Via Docker

src/hots/main.py

+2-7
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,7 @@
11
"""
2-
Entry point of hots module through ``hots path [OPTIONS]``.
3-
4-
- path is the folder where we find the files
5-
6-
* container_usage.csv : describes container resource consumption
7-
* node_meta.csv : describes nodes capacities
8-
* (node_usage.csv : describes nodes resource consumption)
2+
Entry point of hots module through ``hots config_path [OPTIONS]``.
93
4+
- config_path is the configuration file
105
- type ``hots --help`` for options description
116
127
The entire methodology is called from here (initialization, clustering,

0 commit comments

Comments
 (0)