Skip to content

Commit

Permalink
Jupiter docker added, docker folder created, docker files moved to th…
Browse files Browse the repository at this point in the history
…at folder, readme created (#1271)

* Jupiter docker file added, docker folder added, docker files moved to the docker folder

* readme updated
  • Loading branch information
glad4enkonm authored Mar 12, 2024
1 parent 480fd51 commit 4ea3547
Show file tree
Hide file tree
Showing 10 changed files with 104 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ FEDOT предоставляет возможность использовать
Установка
=========

- Cистема управления пакетами **pip**

Самый простой способ установить FEDOT - это использовать ``pip``:

.. code-block::
Expand All @@ -75,6 +77,10 @@ FEDOT предоставляет возможность использовать
$ pip install fedot[extra]
- Контенер **Docker**

Информацию по доступным образам можно посмотреть `здесь <https://github.com/aimclub/FEDOT/tree/master/docker/README.rst>`_.

Как использовать
================

Expand Down
6 changes: 6 additions & 0 deletions README_en.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,8 @@ FEDOT concepts
Installation
============

- Package installer for Python **pip**

The simplest way to install FEDOT is using ``pip``:

.. code-block::
Expand All @@ -75,6 +77,10 @@ Installation with optional dependencies for image and text processing, and for D
$ pip install fedot[extra]
- **Docker** container

Available docker images can be found here `here <https://github.com/aimclub/FEDOT/tree/master/docker/README_en.rst>`_.

How to Use
==========

Expand Down
File renamed without changes.
File renamed without changes.
33 changes: 33 additions & 0 deletions docker/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
FEDOT и Docker
==============

Здесь представлены Docker файлы для запуска FEDOT


Версии
======

- **Dockerfile** Полная версия FEDOT (fedot + fedot[extra]) для python 3.8
- **Dockerfile_light** Лёгкая версия FEDOT для python 3.8
- **GPU** Версия с поддержкой GPU для python 3.8
- **Dockerfile_Jupiter** Версия с Jupiter notebook для python 3.10. Ниже есть описание запуска для Linux.


Jupiter
=======

- **Проверте наличе docker (docker-compose)** docker (docker-compose) должен быть установлен
- `git clone https://github.com/aimclub/FEDOT.git` получаем файлы из git
- `cd FEDOT` переходим в папку проекта
- `cd docker/jupiter` переходим в папку с Docker файлами для jupiter notebook

1. Удобнее запускать с docker-compose

- `docker-compose up` или `docker compose up`
- **копируем ссылку с ключем и открываем** - если запуск прошел как ожидается будет отображена ссылка следующего вида `http://127.0.0.1:8888/lab?token=db8ce02fbed23c3ecd896408a494de176a70d73cf51e203f`

2. Или используя только docker

- `docker build -t jupyter-fedot -f Dockerfile_Jupiter .` строим образ и называем его "jupyter-fedot"
- `docker run -p 8888:8888 -v $(pwd):/home/jovyan/work jupyter-fedot` запускаем, будет доступен по URL `http://[YOUR_IP]:8888`, храним все файлы в текущей папке
- **копируем ссылку с ключем и открываем** - если запуск прошел как ожидается будет отображена ссылка следующего вида `http://127.0.0.1:8888/lab?token=db8ce02fbed23c3ecd896408a494de176a70d73cf51e203f`
33 changes: 33 additions & 0 deletions docker/README_en.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Running FEDOT in Docker
=======================

Here are some dockerfiles to run FEDOT


Versions
========

- **Dockerfile** Full version of FEDOT (fedot + fedot[extra]) for python 3.8
- **Dockerfile_light** Light version of FEDOT (fedot only) for python 3.8
- **GPU** A GPU version of FEDOT for python 3.8
- **Dockerfile_Jupiter** A Jupiter notebook version for python 3.10. Below you can find an instruction on how to run it under Linux.


Jupiter
=======

- **check docker (docker-compose)** docker (docker-compose) should be installed
- `git clone https://github.com/aimclub/FEDOT.git` clone this repo
- `cd FEDOT` navigate to the root folder
- `cd docker/jupiter` navigate to the docker folder with jupiter notebook files

1. Run using docker-compose

- `docker-compose up` or `docker compose up`
- **copy the URL with a token and open in a browser** - if everything runs nornally you will see a link like `http://127.0.0.1:8888/lab?token=db8ce02fbed23c3ecd896408a494de176a70d73cf51e203f`

2. Run using docker

- `docker build -t jupyter-fedot -f Dockerfile_Jupiter .` buid an image and give it a tag "jupyter-fedot"
- `docker run -p 8888:8888 -v $(pwd):/home/jovyan/work jupyter-fedot` run a container, it will be available under `http://[YOUR_IP]:8888`, here we use current dirrectory to store all files
- **copy the URL with a token and open in a browser** - if everything runs nornally you will see a link like `http://127.0.0.1:8888/lab?token=db8ce02fbed23c3ecd896408a494de176a70d73cf51e203f`
File renamed without changes.
File renamed without changes.
16 changes: 16 additions & 0 deletions docker/jupiter/Dockerfile_Jupiter
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
FROM jupyter/minimal-notebook:python-3.10.10

USER root

RUN apt-get update && \
apt-get install -y --no-install-recommends \
build-essential \
cmake \
ffmpeg \
libsm6 \
libxext6 && \
rm -rf /var/lib/apt/lists/*

RUN pip install --no-cache-dir \
fedot \
fedot[extra]
10 changes: 10 additions & 0 deletions docker/jupiter/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
version: '3'
services:
jupyter-fedot:
build:
context: .
dockerfile: Dockerfile_Jupiter
ports:
- "8888:8888"
volumes:
- ./:/home/jovyan/work

0 comments on commit 4ea3547

Please sign in to comment.