ium/IUM_07.Sacred.ipynb

Inżynieria uczenia maszynowego

17 kwietnia 2024

7. Sacred

Sacred

Every experiment is sacred
Every experiment is great
If an experiment is wasted
God gets quite irate

—https://github.com/IDSIA/sacred / Sens życia według Monty Pythona

• https://sacred.readthedocs.io/ - dokumentacja
• https://github.com/IDSIA/sacred - Github
• Open source
• Prosty w użyciu
• Wiele webowych frontendów

• Przeprowadzanie eksperymentów (zmiana parametrów, trenowanie, ewaluacja) uczenia maszynowego jest kosztowne i czasochłonne
• Dlatego warto przeprowadzać je w zorganizowany sposób
• I tak, żebyśmy mogli powtórzyć / odtworzyć raz uzyskane wyniki

Sacred is a tool to help you:

• configure
• organize
• log
• reproduce experiments.

It is designed to do all the tedious overhead work that you need to do around your actual experiment in order to:

• keep track of all the parameters of your experiment
• easily run your experiment for different settings
• save configurations for individual runs in a database
• reproduce your results

—https://github.com/IDSIA/sacred

• ConfigScopes A very convenient way of the local variables in a function to define the parameters your experiment uses.
• Config Injection You can access all parameters of your configuration from every function. They are automatically injected by name.
• Command-line interface You get a powerful command-line interface for each experiment that you can use to change parameters and run different variants.
• Observers Sacred provides Observers that log all kinds of information about your experiment, its dependencies, the configuration you used, the machine it is run on, and of course the result. These can be saved to a MongoDB, for easy access later.
• Automatic seeding helps controlling the randomness in your experiments, such that the results remain reproducible.

Instalacja

!pip3 install sacred

Collecting sacred
  Downloading sacred-0.8.5-py2.py3-none-any.whl (107 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 107.9/107.9 KB 2.3 MB/s eta 0:00:00a 0:00:01
[?25hCollecting jsonpickle>=2.2.0
  Downloading jsonpickle-3.0.4-py3-none-any.whl (39 kB)
Collecting colorama>=0.4
  Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB)
Collecting munch<5.0,>=2.5
  Downloading munch-4.0.0-py2.py3-none-any.whl (9.9 kB)
Requirement already satisfied: packaging>=18.0 in ./venv/lib/python3.10/site-packages (from sacred) (24.0)
Collecting wrapt<2.0,>=1.0
  Downloading wrapt-1.16.0-cp310-cp310-manylinux_2_5_x86_64.manylinux1_x86_64.manylinux_2_17_x86_64.manylinux2014_x86_64.whl (80 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 80.3/80.3 KB 12.1 MB/s eta 0:00:00
[?25hCollecting docopt<1.0,>=0.3
  Downloading docopt-0.6.2.tar.gz (25 kB)
  Preparing metadata (setup.py) ... [?25ldone
[?25hCollecting GitPython
  Downloading GitPython-3.1.43-py3-none-any.whl (207 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 207.3/207.3 KB 9.6 MB/s eta 0:00:00
[?25hCollecting py-cpuinfo>=4.0
  Downloading py_cpuinfo-9.0.0-py3-none-any.whl (22 kB)
Collecting gitdb<5,>=4.0.1
  Downloading gitdb-4.0.11-py3-none-any.whl (62 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 62.7/62.7 KB 15.1 MB/s eta 0:00:00
[?25hCollecting smmap<6,>=3.0.1
  Downloading smmap-5.0.1-py3-none-any.whl (24 kB)
Using legacy 'setup.py install' for docopt, since package 'wheel' is not installed.
Installing collected packages: py-cpuinfo, docopt, wrapt, smmap, munch, jsonpickle, colorama, gitdb, GitPython, sacred
  Running setup.py install for docopt ... [?25ldone
[?25hSuccessfully installed GitPython-3.1.43 colorama-0.4.6 docopt-0.6.2 gitdb-4.0.11 jsonpickle-3.0.4 munch-4.0.0 py-cpuinfo-9.0.0 sacred-0.8.5 smmap-5.0.1 wrapt-1.16.0

Funkcja main

%%writefile IUM_07/sacred_hello.py
from sacred import Experiment

ex = Experiment()

@ex.automain
def my_main():
    print('Witaj świecie!')

Overwriting IUM_07/sacred_hello.py

!python3 IUM_07/sacred_hello.py

WARNING - sacred_hello - No observers have been added to this run
INFO - sacred_hello - Running command 'my_main'
INFO - sacred_hello - Started
Witaj świecie!
INFO - sacred_hello - Completed after 0:00:00

Co się dzieje w kodzie powyżej?

1. Tworzymy obiekt klasy Experiment
2. Dekorujemy funkcję "my_main" dekoratorem automain Dzięki temu:
   • otrzymujemy interfejs CLI, m.in. do kontrolowania poziomu logowania, przekazywania parametrów itp.
   • oznaczamy funkcję "my_main" jako główną funkcję, która będzie wywoływana podczas wykonywania eksperymentu
   • funkcja oznaczona jako główna musi być ostatnią funkcją zdefiniowaną w pliku!

Co nam daje interejs CLI:

!python3 IUM_07/sacred_hello.py -h

Usage:
  sacred_hello.py [(with UPDATE...)] [options]
  sacred_hello.py help [COMMAND]
  sacred_hello.py (-h | --help)
  sacred_hello.py COMMAND [(with UPDATE...)] [options]



Options:
  -b VALUE --beat-interval=VALUE  Set the heart-beat interval for this run.  Time
                                between two heartbeat events is measured in
                                seconds.
  -C VALUE --capture=VALUE      Control the way stdout and stderr are captured.
                                The argument value must be one of [no, sys, fd]
  -c VALUE --comment=VALUE      Add a comment to this run.
  -d --debug                    Set this run to debug mode.  Suppress warnings
                                about missing observers and don't filter the
                                stacktrace. Also enables usage with ipython
                                `--pdb`.
  -e --enforce_clean            Fail if any version control repository is
                                dirty.
  -F VALUE --file_storage=VALUE  Add a file-storage observer to the experiment.
                                The value of the arguement should be the base-
                                directory to write the runs to
  -f --force                    Disable warnings about suspicious changes for
                                this run.
  -h --help                     Print this help message and exit.
  -i VALUE --id=VALUE           Set the id for this run.
  -l VALUE --loglevel=VALUE     Set the LogLevel.  Loglevel either as 0 - 50 or
                                as string: DEBUG(10), INFO(20), WARNING(30),
                                ERROR(40), CRITICAL(50)
  -m VALUE --mongo_db=VALUE     Add a MongoDB Observer to the experiment.  The
                                argument value is the database specification.
                                Should be in the form:  `[host:port:]db_name[.c
                                ollection[:id]][!priority]`
  -n VALUE --name=VALUE         Set the name for this run.
  -D --pdb                      Automatically enter post-mortem debugging with
                                pdb on failure.
  -p --print-config             Always print the configuration first.
  -P VALUE --priority=VALUE     Sets the priority for a queued up experiment.
                                `--priority=NUMBER` The number represent the
                                priority for this run.
  -q --queue                    Only queue this run, do not start it.
  -S VALUE --s3=VALUE           Add a S3 File observer to the experiment.  The
                                argument value should be
                                `s3://<bucket>/path/to/exp`.
  -s VALUE --sql=VALUE          Add a SQL Observer to the experiment.  The
                                typical form is:
                                dialect://username:password@host:port/database
  -t VALUE --tiny_db=VALUE      Add a TinyDB Observer to the experiment.  The
                                argument is the path to be given to the
                                TinyDbObserver.
  -u --unobserved               Ignore all observers for this run.


Arguments:
  COMMAND   Name of command to run (see below for list of commands)
  UPDATE    Configuration assignments of the form foo.bar=17


Commands:
  print_config         Print the updated configuration and exit.
  print_dependencies   Print the detected source-files and dependencies.
  save_config          Store the updated configuration in a file.
  print_named_configs  Print the available named configs and exit.
  my_main              

Konfiguracje

• Konfiguracje pozwalają nam sparametryzować wywołania eksperymentu.
• Ułatwiają przekazywanie parametrów - zmienne z konfiguracji są wstrzykiwane do funkcji wywoływanych
• Mogą być automatycznie zapisywane (dzięki czemu możemy śledzić jak zmieniały się parametry i jaki miały wpływ na wyniki)
• Konfigurację można stworzyć w jeden z 3 sposobów:
  • używając config scopes (z dekoratorem @config)
  • jako słownik
  • wczytując ją z pliku

Konfiguracje - config scopes

Jeśli oznaczymy jakąś funkcję dekoratorem @config, to zostanie ona uruchoniona przed wywołaniem eksperymentu i wszystkie jej lokalne zmienne, które da się zserializować jako json, zostaną dodane do konfiguracji. Potem ich wartości zostaną wstrzyknięte do innych funkcji wywoływanych w eksperymencie.

from sacred import Experiment

exint = Experiment("sacred_scopes", interactive=True) #Jeśli wykonujemy interaktywnie (w konsoli Pythona albo w Jupyter):
# - musimy podać nazwę eksperymentu (domyślnie jako nazwa używana jest nazwa pliku źródłowego)
# - musimy dodać parametr "interactive=True"
# - zamiast dekoratora "@ex.automain" używamy "@ex.main"

@exint.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"
    message = "{0} {1}!".format(greeting, recipient)


@exint.main
def my_main(message):
    print(message)

exint.run()

WARNING - sacred_scopes - No observers have been added to this run
INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started
INFO - sacred_scopes - Completed after 0:00:00

Witaj Świecie!

<sacred.run.Run at 0x7ff6cf76d600>

Możemy podejrzeć wartości zmiennych w konfiguracji:

my_config()

{'recipient': 'Świecie', 'greeting': 'Witaj', 'message': 'Witaj Świecie!'}

Parametry możemy podejrzeć i modyfikować z poziomu CLI

• wartości podane w CLI nadpiszą te podane w kodzie

%%writefile IUM_07/sacred_scopes.py
from sacred import Experiment

ex = Experiment()

@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"
    message = "{0} {1}!".format(greeting, recipient)

@ex.automain
def my_main(message):
    print(message)

Overwriting IUM_07/sacred_scopes.py

!python3 IUM_07/sacred_scopes.py with 'recipient=Przygodo'

WARNING - sacred_scopes - No observers have been added to this run
INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started
Witaj Przygodo!
INFO - sacred_scopes - Completed after 0:00:00

!python3 IUM_07/sacred_scopes.py print_config

INFO - sacred_scopes - Running command 'print_config'
INFO - sacred_scopes - Started
Configuration (modified, added, typechanged, doc):
  greeting = 'Witaj'
  message = 'Witaj Świecie!'
  recipient = 'Świecie'
  seed = 166269169                   # the random seed for this experiment
INFO - sacred_scopes - Completed after 0:00:00

!python IUM_07/sacred_scopes.py print_config with 'recipient=Przygodo'

INFO - sacred_scopes - Running command 'print_config'
INFO - sacred_scopes - Started
Configuration (modified, added, typechanged, doc):
  greeting = 'Witaj'
  message = 'Witaj Przygodo!'
  recipient = 'Przygodo'
  seed = 496449715                   # the random seed for this experiment
INFO - sacred_scopes - Completed after 0:00:00

Wczytywanie konfiguracji z pliku

# %load IUM_07/config.json
{
    "recipient": "samotności",
    "greeting": "Żegnaj"
}

{'recipient': 'samotności', 'greeting': 'Żegnaj'}

from sacred import Experiment

ex = Experiment("sacred_scopes", interactive=True) #Jeśli wykonujemy interaktywnie (w konsoli Pythona albo w Jupyter):
# - musimy podać nazwę eksperymentu (domyślnie jako nazwa używana jest nazwa pliku źródłowego)
# - musimy dodać parametr "interactive=True"
# - zamiast "automain" używamy parametru "main"

@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

ex.add_config("IUM_07/config.json")


@ex.main
def my_main(recipient, greeting):
    print("{0} {1}!".format(greeting, recipient))

r = ex.run()

WARNING - sacred_scopes - No observers have been added to this run
INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started
INFO - sacred_scopes - Completed after 0:00:00

Żegnaj samotności!

r.config

{'recipient': 'samotności', 'greeting': 'Żegnaj', 'seed': 557578089}

Możemy modyfikować części konfiguracji bezpośrednio przed wywołaniem

r = ex.run(config_updates={"recipient":"nudo"})

WARNING - sacred_scopes - No observers have been added to this run
INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started
INFO - sacred_scopes - Completed after 0:00:00

Żegnaj nudo!

Wstrzykiwanie zależności

• Oprócz funkcji głównej, wartości z konfiguracji są też wstrzykiwane do funkcji udekorowanych dekoratorem @ex.capture
• Możemy korzystać w nich ze specjalnych parametrów, np.:
  • _log - daje nam dostęp do obiektu logera (więcej: logowanie)
  • _run - daje dostęp do obiektu reprezentującego aktualne wywołanie eksperymentu (przykład później)

from sacred import Experiment

ex = Experiment("sacred_scopes", interactive=True)

@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

@ex.capture
def prepare_message(recipient, greeting, _log):
    _log.info("Enterred prepare_message")
    return "{0} {1}!".format(greeting, recipient)

@ex.main
def my_main():
    print(prepare_message()) ## Nie musimy przekazywać wartości
    
ex.run()

WARNING - sacred_scopes - No observers have been added to this run
INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started
INFO - prepare_message - Enterred prepare_message
INFO - sacred_scopes - Completed after 0:00:00

Witaj Świecie!

<sacred.run.Run at 0x7ff69f8c0610>

Obserwowanie eksperymentów

Sacred zapisuje szereg informacji na temat każdego eksperymentu:

• czas wykonania
• konfigurację
• tekst zwrócony na stdout/stderr
• błędy, jeśli wystąpiły
• podstawowe informacje o środowisku (maszynie), na której przeprowadzono eksperyment
• użyte pliki źródłowe
• użyte zależności i ich wersje
• pliki otwarte za pomocą ex.open_resource() albo ex.add_resource()
• pliki dodane za pomocą ex.add_artifact()

!ls -l my_runs

total 8
drwxr-xr-x 2 pawel pawel 4096 Apr 17 07:51 1
drwxr-xr-x 2 pawel pawel 4096 Apr 17 07:51 _sources

Obserwowane infromacje mogą zostać zapisane za pomocą jednego z obserwatorów:

• Mongo Observer - zapisuje dane w MongoDB
• File Storage Observer - zapisuje dane lokalnie w pliku
• TinyDB Observer - korzysta z lokalnej bazy zapisanej w pliku JSON
• SQL Observer - przechowuje informacje w bazie SQL
• S3 Observer - korzysta z AWS S3
• gcs_observer - korzysta z Google Cloud Storage
• Queue Observer - rodzaj lokalnego bufora nakładanego na jeden z powyższych
• Slack Observer - używany do powiadomień wysyłanych na komunikator Slack
• Telegram Observer - używany do powiadomień wysyłanych na komunikator Telegram

File storage observer

• zapisuje informacje o eksperymencie w lokalnych plikach
• można go dodać tak: ex.observers.append(FileStorageObserver('my_runs_directory')), gdzie my_runs_directory to ścieżka, gdzie będą zapisywane informacje o eksperymentach

%%writefile IUM_07/file_observer.py
from sacred.observers import FileStorageObserver
from sacred import Experiment

ex = Experiment("file_observer")

ex.observers.append(FileStorageObserver('my_runs'))

@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

@ex.capture
def prepare_message(recipient, greeting):
    return "{0} {1}!".format(greeting, recipient)

@ex.automain
def my_main(recipient, greeting):
    print(prepare_message()) ## Nie musimy przekazywać wartości

Overwriting IUM_07/file_observer.py

!python3 IUM_07/file_observer.py

INFO - file_observer - Running command 'my_main'
INFO - file_observer - Started run with ID "1"
Witaj Świecie!
INFO - file_observer - Completed after 0:00:00

Zobaczmy jakie informacje zostały zapisane

!ls -l my_runs

total 8
drwxr-xr-x 2 pawel pawel 4096 Apr 17 07:51 1
drwxr-xr-x 2 pawel pawel 4096 Apr 17 07:51 _sources

!ls -l my_runs/1

total 16
-rw-r--r-- 1 pawel pawel   77 Apr 17 07:51 config.json
-rw-r--r-- 1 pawel pawel  159 Apr 17 07:51 cout.txt
-rw-r--r-- 1 pawel pawel    2 Apr 17 07:51 metrics.json
-rw-r--r-- 1 pawel pawel 1715 Apr 17 07:51 run.json

# %load my_runs/1/config.json
{
  "greeting": "Witaj",
  "recipient": "\u015awiecie",
  "seed": 805857632
}

{'greeting': 'Witaj', 'recipient': 'Świecie', 'seed': 805857632}

!cat my_runs/1/cout.txt

INFO - file_observer - Running command 'my_main'
INFO - file_observer - Started run with ID "1"
Witaj Świecie!
INFO - file_observer - Completed after 0:00:00

# %load my_runs/1/run.json
{
  "artifacts": [],
  "command": "my_main",
  "experiment": {
    "base_dir": "/home/tomek/repos/aitech/aitech-ium/IUM_07",
    "dependencies": [
      "sacred==0.8.2"
    ],
    "mainfile": "file_observer.py",
    "name": "file_observer",
    "repositories": [
      {
        "commit": "3055a4f1c2ef06ea1c29e3d41d862827cede7e2a",
        "dirty": true,
        "url": "git@git.wmi.amu.edu.pl:tzietkiewicz/aitech-ium.git"
      }
    ],
    "sources": [
      [
        "file_observer.py",
        "_sources/file_observer_cd34a0ef4a32fb0a966eaa01ea6371ad.py"
      ]
    ]
  },
  "heartbeat": "2022-04-25T07:51:37.853633",
  "host": {
    "ENV": {},
    "cpu": "Intel(R) Core(TM) i5-4200H CPU @ 2.80GHz",
    "hostname": "ASUSEK",
    "os": [
      "Linux",
      "Linux-4.4.0-19041-Microsoft-x86_64-with-Ubuntu-18.04-bionic"
    ],
    "python_version": "3.6.9"
  },
  "meta": {
    "command": "my_main",
    "options": {
      "--beat-interval": null,
      "--capture": null,
      "--comment": null,
      "--debug": false,
      "--enforce_clean": false,
      "--file_storage": null,
      "--force": false,
      "--help": false,
      "--loglevel": null,
      "--mongo_db": null,
      "--name": null,
      "--pdb": false,
      "--print-config": false,
      "--priority": null,
      "--queue": false,
      "--s3": null,
      "--sql": null,
      "--tiny_db": null,
      "--unobserved": false,
      "COMMAND": null,
      "UPDATE": [],
      "help": false,
      "with": false
    }
  },
  "resources": [],
  "result": null,
  "start_time": "2022-04-25T07:51:37.831461",
  "status": "COMPLETED",
  "stop_time": "2022-04-25T07:51:37.849334"
}

! ls -l my_runs/_sources
## W run.json możemy znaleźć ścieżkę do pliku z źródłami:         "_sources/file_observer_bb0a5c4720d1072b641d23da080696b6.py"

total 4
-rw-r--r-- 1 pawel pawel 464 Apr 17 07:51 file_observer_cd34a0ef4a32fb0a966eaa01ea6371ad.py

# %load my_runs/_sources/file_observer_cd34a0ef4a32fb0a966eaa01ea6371ad.py
from sacred.observers import FileStorageObserver
from sacred import Experiment

ex = Experiment("file_observer")

ex.observers.append(FileStorageObserver('my_runs'))

@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

@ex.capture
def prepare_message(recipient, greeting):
    return "{0} {1}!".format(greeting, recipient)

@ex.automain
def my_main(recipient, greeting):
    print(prepare_message()) ## Nie musimy przekazywać wartości

---------------------------------------------------------------------------
RuntimeError                              Traceback (most recent call last)
Cell In[33], line 5
      2 from sacred.observers import FileStorageObserver
      3 from sacred import Experiment
----> 5 ex = Experiment("file_observer")
      7 ex.observers.append(FileStorageObserver('my_runs'))
      9 @ex.config
     10 def my_config():

File ~/ium/venv/lib/python3.10/site-packages/sacred/experiment.py:119, in Experiment.__init__(self, name, ingredients, interactive, base_dir, additional_host_info, additional_cli_options, save_git_info)
    117     elif name.endswith(".pyc"):
    118         name = name[:-4]
--> 119 super().__init__(
    120     path=name,
    121     ingredients=ingredients,
    122     interactive=interactive,
    123     base_dir=base_dir,
    124     _caller_globals=caller_globals,
    125     save_git_info=save_git_info,
    126 )
    127 self.default_command = None
    128 self.command(print_config, unobserved=True)

File ~/ium/venv/lib/python3.10/site-packages/sacred/ingredient.py:79, in Ingredient.__init__(self, path, ingredients, interactive, _caller_globals, base_dir, save_git_info)
     71 (
     72     self.mainfile,
     73     self.sources,
   (...)
     76     _caller_globals, save_git_info, self.base_dir
     77 )
     78 if self.mainfile is None and not interactive:
---> 79     raise RuntimeError(
     80         "Defining an experiment in interactive mode! "
     81         "The sourcecode cannot be stored and the "
     82         "experiment won't be reproducible. If you still"
     83         " want to run it pass interactive=True"
     84     )

RuntimeError: Defining an experiment in interactive mode! The sourcecode cannot be stored and the experiment won't be reproducible. If you still want to run it pass interactive=True

Dodawanie własnych informacji

from sacred.observers import FileStorageObserver
from sacred import Experiment
from datetime import datetime

ex = Experiment("file_observer", interactive=True)

ex.observers.append(FileStorageObserver('my_runs'))

@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

### - Do "przechwyconej" przez @ex.capture funkcji prepare_message dodaliśmy specjalny parametr _run
### - Daje on dostęp do obiektu wywołania eksperymentu w trakcie jego wywołania
### - umożliwia m.in. zapisywanie dodatkowych informacji w słowniku info
@ex.capture
def prepare_message(recipient, greeting, _run):
    _run.info["prepare_message_ts"] = str(datetime.now())
    return "{0} {1}!".format(greeting, recipient)

@ex.main
def my_main(recipient, greeting):
    print(prepare_message()) ## Nie musimy przekazywać wartości
    
r = ex.run()

INFO - file_observer - Running command 'my_main'
INFO - file_observer - Started run with ID "3"
INFO - file_observer - Completed after 0:00:00

Witaj Świecie!

cat my_runs/3/info.json

{
  "prepare_message_ts": "2024-04-17 07:53:12.105121"
}

Artefakty

• Artefakty służą do zapisywania plików, np. z wytrenowanym modelem
• Plik można zapisać jako artefakt korzystając z : ex.add_artifact()

  ex.add_artifact("model.pb")
  

Otwieranie zasobów

• Zmiana danych wejściowych wpłwa w oczywisty sposób na wyniki
• Dlatego warto śledzić te zmiany za pomocą:
  • ex.open_resource()
  • ex.add_resource()

from sacred import Experiment
from sacred.observers import FileStorageObserver


ex = Experiment("resources", interactive=True)
ex.observers.append(FileStorageObserver('my_runs'))

@ex.main
def my_main():
    f = ex.open_resource("Iris.csv", "r")
    print(f.readline())
    
ex.run()

INFO - resources - Running command 'my_main'
INFO - resources - Started run with ID "6"
INFO - resources - Completed after 0:00:00

Id,SepalLengthCm,SepalWidthCm,PetalLengthCm,PetalWidthCm,Species

<sacred.run.Run at 0x7f89a0db5a30>

!ls -l my_runs/_resources

total 8
-rw-r--r-- 1 tomek tomek 5107 Apr 12 15:11 Iris_717820ef0af287ff346c5cabfb4c612c.csv

!grep -e "resources" -R my_runs/6

my_runs/6/run.json:    "name": "resources",
my_runs/6/run.json:  "resources": [
my_runs/6/run.json:      "my_runs/_resources/Iris_717820ef0af287ff346c5cabfb4c612c.csv"

Obserwator mongo

• Żeby skorzystać z obserwatora Mongo, musimy mieć dostęp do bazy Mongo.
• Można ją łatwo "postawić" za pomocą docker-compose .
• W tym celu wystarczy skopiować katalog examples/docker z repozytorium SACRED i uruchomić docker-compose up - dostaniemy uruchomioną bazę MongoDB i dodatkowo Omniboard . Więcej informacji w dokumentacji
• Baza taka została już postawiona na serwerze Jenkins, więc pracując na Jenkinsie można skorzystać z lokalnej bazy (localhost:27017)

!pip3 install pymongo

Collecting pymongo
  Downloading pymongo-4.6.3-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl (676 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 676.9/676.9 KB 2.4 MB/s eta 0:00:00a 0:00:01
[?25hCollecting dnspython<3.0.0,>=1.16.0
  Downloading dnspython-2.6.1-py3-none-any.whl (307 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 307.7/307.7 KB 1.4 MB/s eta 0:00:0000:0100:01
[?25hInstalling collected packages: dnspython, pymongo
Successfully installed dnspython-2.6.1 pymongo-4.6.3

from sacred.observers import MongoObserver
from sacred import Experiment

ex = Experiment("sacred_scopes", interactive=True)
ex.observers.append(MongoObserver(url='mongodb://admin:IUM_2021@tzietkiewicz.vm.wmi.amu.edu.pl:27017',
                                  db_name='sacred'))  # Tutaj podajemy dane uwierzytelniające i nazwę bazy skonfigurowane w pliku .env podczas uruchamiania bazy.
# W przypadku instancji na Jenkinsie url będzie wyglądał następująco: mongodb://admin:IUM_2021@tzietkiewicz.vm.wmi.amu.edu.pl:27017
@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

@ex.capture
def prepare_message(recipient, greeting):
    return "{0} {1}!".format(greeting, recipient)

@ex.main
def my_main(recipient, greeting):
    print(prepare_message()) ## Nie musimy przekazywać wartości
    
ex.run()

INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started run with ID "641"
INFO - sacred_scopes - Completed after 0:00:00

Witaj Świecie!

<sacred.run.Run at 0x7ff69f7a74f0>

• Informacje o eksperymencie można obejrzeć na Omniboard: http://127.0.0.1:9000/sacred
• Instancja na Jenkinsie: http://tzietkiewicz.vm.wmi.amu.edu.pl:9000/sacred

Metryki

• W trakcie eksperymentu możemy śledzić metryki, np. aktualny loss
• W tym celu wystarczy:
  • dodać do funkcji udekorowanej @ex.main albo @ex.capure parametr _run
  • potem wywołać np. _run.log_scalar()

from sacred.observers import MongoObserver
from sacred import Experiment
import random
import time

ex = Experiment("sacred_scopes", interactive=True)
ex.observers.append(MongoObserver(url='mongodb://admin:IUM_2021@tzietkiewicz.vm.wmi.amu.edu.pl:27017',
                                  db_name='sacred'))  # Tutaj podajemy dane uwierzytelniające i nazwę bazy skonfigurowane w pliku .env podczas uruchamiania bazy.
# W przypadku instancji na Jenkinsie url będzie wyglądał następująco: mongodb://admin:IUM_2021@tzietkiewicz.vm.wmi.amu.edu.pl:27017
@ex.config
def my_config():
    recipient = "Świecie"
    greeting = "Witaj"

@ex.capture
def prepare_message(recipient, greeting):
    return "{0} {1}!".format(greeting, recipient)

@ex.main
def my_main(recipient, greeting, _run):
    print(prepare_message()) ## Nie musimy przekazywać wartości  
    counter = 0
    while counter < 20:
        counter+=1
        value = counter
        ms_to_wait = random.randint(5, 5000)
        time.sleep(ms_to_wait/1000)
        noise = 1.0 + 0.1 * (random.randint(0, 10) - 5)
        # This will add an entry for training.loss metric in every second iteration.
        # The resulting sequence of steps for training.loss will be 0, 2, 4, ...
        if counter % 2 == 0:
           _run.log_scalar("training.loss", value * 1.5 * noise, counter)
        # Implicit step counter (0, 1, 2, 3, ...)
        # incremented with each call for training.accuracy:
        _run.log_scalar("training.accuracy", value * 2 * noise)

ex.run()    

INFO - sacred_scopes - Running command 'my_main'
INFO - sacred_scopes - Started run with ID "642"

Witaj Świecie!

INFO - sacred_scopes - Completed after 0:00:39

<sacred.run.Run at 0x7ff6c726dcf0>

Wartości metryk możemy na żywo śledzić w Omniboard

Zadanie [15 pkt] (do 2024-06-12)

1. "Owiń" wywołanie swojego eksperymentu za pomocą Sacred, w ten sposób, żeby zapisane zostały [10pkt]:

• parametry, z którymi wywołany był trening

• powstały plik z modelem (jako artefakt)

• kod źródłowy użyty do przeprowadzenia treningu

• pliki wejściowe otwarte za pomocą open_resource

• metryki

  Jako nazwę eksperymentu użyj swojego numeru indeksu tak, żebyś mogła/mógł je odnaleźć w Omniboard

2. Wykorzystaj co najmniej jeden z następujących obserwatorów [5pkt]:

• MongoObserver, skorzytaj nastęþującego URL: mongodb://admin:IUM_2021@tzietkiewicz.vm.wmi.amu.edu.pl:27017
• FileObserver - zapisane pliki zarchiwizuj na Jenkinsie jako jego artefakty