Skip to content

Commit ecaf837

Browse files
authored
readme fix (#29)
fixed readme for synthetic example
1 parent e7b036a commit ecaf837

File tree

4 files changed

+24
-6
lines changed

4 files changed

+24
-6
lines changed

examples/ice_concentration/README_RU.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
## Пример прогнозирования концентрации льда
33

44
Данные о ледовой обстановке были подготовлены на основе продукта OSI SAF.
5-
Скачать подготовленный образец для запуска примера можно [здесь](https://disk.yandex.ru/d/C8KrnPCr65nqSw).
5+
Скачать подготовленный образец для запуска примера можно [здесь](https://disk.yandex.ru/d/sdj5K7wh-unXdA).
66

77
После скачивания данных, необходимо указать директорию с данными в файле
88
[``` data_loader```](data_loader.py) - ``` /path_to_data/``` .

examples/synthetic_noise_examples/README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,13 @@ Models train script with grid of experiments: [``` grid_train.py```](grid_train.
1818

1919
Tools for data generation and logging: [``` tools.py```](tools.py)
2020

21-
Notebook with results visualization: [``` results.ipynb```](results.ipynb)
21+
Notebook with results visualization: [``` results.ipynb```](results.ipynb)
22+
23+
For separated training of the best setup excluding grid of experiments script [```best_train.py```](best_train.py)
24+
can be used. Part of the output of this script is in [```best model```](best%20model) folder for clarity.
25+
26+
Python (.py) files can be run with command below or with IDE.
27+
```
28+
python file_name.py
29+
```
30+

examples/synthetic_noise_examples/README_RU.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,20 @@
1212
<img src="noise_examples/noise_50.gif" style="width:150px;">
1313
</p>
1414

15-
- Для запуска примера требуется запустить сетку экспериментов
15+
Для запуска примера требуется запустить сетку экспериментов
1616
с обучением различных архитектур, собранных с помощью библиотеки - [``` grid_train.py```](grid_train.py).
1717

18-
- Обратите внимание, что вспомогательные функции, реализующие генерацию
18+
Обратите внимание, что вспомогательные функции, реализующие генерацию
1919
синтетических данных и логирование реализованы в файле [``` tools.py```](tools.py).
2020

21-
- Для оценки результатов обучения архитектур реализован блокнот с комментариями
21+
Для оценки результатов обучения архитектур реализован блокнот с комментариями
2222
к ячейкам [``` results.ipynb```](results.ipynb).
23+
24+
Для отдельного обучения лучшей архитектуры вне сетки экспериментов, можно воспользоваться скриптом
25+
[```best_train.py```](best_train.py). Часть вывода данного скрипта для наглядности представлена в папке
26+
[```best model```](best%20model).
27+
28+
Скрипты .py могут быть запущены следующей командой либо с помощью IDE.
29+
```
30+
python file_name.py
31+
```

examples/synthetic_noise_examples/best_train.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@
128128
# iterations
129129
# ------------------------------------
130130
# logging
131-
exp_path = 'best model/'
131+
exp_path = 'best_model/'
132132
log_print(logger, f'start {exp_path}')
133133
if not os.path.exists(exp_path):
134134
os.makedirs(exp_path)

0 commit comments

Comments
 (0)