diff --git a/examples/README.md b/examples/README.md index 89adcf8..7975e1c 100644 --- a/examples/README.md +++ b/examples/README.md @@ -1,5 +1,28 @@ [[Click For Russian version]](README_RU.md) +## Quick Start + +1. Clone the repository: + ```bash + git clone https://github.com/ChrisLisbon/TorchCNNBuilder.git + cd TorchCNNBuilder + +2. Install in development mode (recommended): + ```bash + pip install -e . + +**This will**: install all required dependencies, make the package available system-wide, allow +you to modify code and see changes immediately. + +3. For just running examples (without development): + ```bash + pip install numpy torch matplotlib jupyter + +4. ⚠️ Note: The examples use relative paths for data loading. +To avoid file not found errors, always launch Jupyter from the repository root directory: + ```bash + jupyter notebook examples/example_name.ipynb + # Usage examples Relevant usage examples can be found in this directory. The API examples of each submodule are located in the corresponding `ipynb` file: diff --git a/examples/README_RU.md b/examples/README_RU.md index 99d61b1..b2f302d 100644 --- a/examples/README_RU.md +++ b/examples/README_RU.md @@ -1,5 +1,29 @@ # Примеры использования +## Быстрый старт + +1. Клонируйте репозиторий: + ```bash + git clone https://github.com/ChrisLisbon/TorchCNNBuilder.git + cd TorchCNNBuilder + +2. Установка в режиме разработки (рекомендуется): + ```bash + pip install -e . + +**Это позволит**: установить все необходимые зависимости, сделать пакет доступным системе, +видеть изменения в коде без переустановки. + +3. Только для запуска примеров (без разработки): + + ```bash + pip install numpy torch matplotlib jupyter + +4. ⚠️ Важно! Примеры используют относительные пути к данным. +Всегда запускайте ноутбуки из корня репозитория: + ```bash + jupyter notebook examples/имя_примера.ipynb + ## Примеры работы с компонентами библиотеки Примеры обращения в API для каждого подмодуля расположены в соответствующих файлах `ipynb`: - [`torchcnnbuilder`](usage_examples/main_examples_ru.ipynb) - основные переменные и мат. аппартат сверток diff --git a/examples/anime_example.ipynb b/examples/anime_example.ipynb index 3b97312..6e39c42 100644 --- a/examples/anime_example.ipynb +++ b/examples/anime_example.ipynb @@ -9,7 +9,6 @@ { "metadata": {}, "cell_type": "code", - "outputs": [], "execution_count": null, "source": [ "!pip install numpy\n", @@ -17,7 +16,8 @@ "!pip install matplotlib \n", "!pip install pillow" ], - "id": "9a0fa490fe399727" + "id": "9a0fa490fe399727", + "outputs": [] }, { "metadata": {}, diff --git a/examples/anime_example_ru.ipynb b/examples/anime_example_ru.ipynb index 914fe2e..6295778 100644 --- a/examples/anime_example_ru.ipynb +++ b/examples/anime_example_ru.ipynb @@ -47,8 +47,8 @@ "id": "e6a3d5d05db5d1ab", "metadata": { "ExecuteTime": { - "end_time": "2025-07-01T13:28:21.510394Z", - "start_time": "2025-07-01T13:28:21.372396Z" + "end_time": "2025-08-07T15:26:29.602405Z", + "start_time": "2025-08-07T15:26:29.491405Z" } }, "source": [ @@ -94,8 +94,8 @@ "id": "61165453374fda73", "metadata": { "ExecuteTime": { - "end_time": "2025-07-01T13:28:44.614031Z", - "start_time": "2025-07-01T13:28:44.113957Z" + "end_time": "2025-08-07T15:26:30.165543Z", + "start_time": "2025-08-07T15:26:29.743406Z" } }, "source": [ @@ -148,8 +148,8 @@ "id": "4fdf405ba3465604", "metadata": { "ExecuteTime": { - "end_time": "2025-07-01T13:30:29.858767Z", - "start_time": "2025-07-01T13:30:28.296769Z" + "end_time": "2025-08-07T15:26:32.311631Z", + "start_time": "2025-08-07T15:26:31.071571Z" } }, "source": [ @@ -173,8 +173,8 @@ { "metadata": { "ExecuteTime": { - "end_time": "2025-07-01T13:31:15.123617Z", - "start_time": "2025-07-01T13:31:14.942092Z" + "end_time": "2025-08-07T15:26:32.483645Z", + "start_time": "2025-08-07T15:26:32.312634Z" } }, "cell_type": "code", @@ -203,8 +203,8 @@ { "metadata": { "ExecuteTime": { - "end_time": "2024-10-14T14:13:30.181383Z", - "start_time": "2024-10-14T14:13:29.281678Z" + "end_time": "2025-08-07T15:26:34.038192Z", + "start_time": "2025-08-07T15:26:33.359231Z" } }, "cell_type": "code", @@ -222,8 +222,8 @@ "epochs_list = []" ], "id": "5bb4b425f1a33233", - "execution_count": 5, - "outputs": [] + "outputs": [], + "execution_count": 5 }, { "metadata": {}, @@ -234,8 +234,8 @@ { "metadata": { "ExecuteTime": { - "end_time": "2024-10-14T14:25:59.822849Z", - "start_time": "2024-10-14T14:19:12.883444Z" + "end_time": "2025-08-07T15:33:42.113459Z", + "start_time": "2025-08-07T15:26:35.837073Z" } }, "cell_type": "code", @@ -296,8 +296,30 @@ "print(f'time spent: {end-start}')" ], "id": "1075054a695b6ee0", - "execution_count": 10, - "outputs": [] + "outputs": [ + { + "data": { + "text/plain": [ + " 0%| | 0/100000 [00:00\n", "