Tutorial DataSaver#

Note

Because this documentation consists of static html, the live_plot and live_info widget is not live. Download the notebook in order to see the real behaviour. 1

import adaptive

adaptive.notebook_extension()

If the function that you want to learn returns a value along with some metadata, you can wrap your learner in an adaptive.DataSaver.

In the following example the function to be learned returns its result and the execution time in a dictionary:

from operator import itemgetter


def f_dict(x):
    """The function evaluation takes roughly the time we `sleep`."""
    import random
    from time import sleep

    waiting_time = random.random()
    sleep(waiting_time)
    a = 0.01
    y = x + a**2 / (a**2 + x**2)
    return {"y": y, "waiting_time": waiting_time}


# Create the learner with the function that returns a 'dict'
# This learner cannot be run directly, as Learner1D does not know what to do with the 'dict'
_learner = adaptive.Learner1D(f_dict, bounds=(-1, 1))

# Wrapping the learner with 'adaptive.DataSaver' and tell it which key it needs to learn
learner = adaptive.DataSaver(_learner, arg_picker=itemgetter("y"))

learner.learner is the original learner, so learner.learner.loss() will call the correct loss method.

runner = adaptive.Runner(learner, loss_goal=0.1)
await runner.task  # This is not needed in a notebook environment!
runner.live_info()
runner.live_plot(plotter=lambda l: l.learner.plot(), update_interval=0.1)

Now the DataSavingLearner will have an dictionary attribute extra_data that has x as key and the data that was returned by learner.function as values.

learner.extra_data
OrderedDict([(-1,
              {'y': -0.9999000099990001, 'waiting_time': 0.5918328221812502}),
             (1, {'y': 1.000099990001, 'waiting_time': 0.8490182293487707}),
             (0.0, {'y': 1.0, 'waiting_time': 0.47736291510677}),
             (-0.75,
              {'y': -0.7498222538215429, 'waiting_time': 0.1278337877339749}),
             (-0.5,
              {'y': -0.4996001599360256, 'waiting_time': 0.6922711359339664}),
             (0.5,
              {'y': 0.5003998400639744, 'waiting_time': 0.25532977263671963}),
             (-0.25,
              {'y': -0.24840255591054314, 'waiting_time': 0.9596592418033254}),
             (-0.375,
              {'y': -0.3742893942085628, 'waiting_time': 0.8595961031071159}),
             (0.75,
              {'y': 0.7501777461784571, 'waiting_time': 0.11623554549123594}),
             (-0.125,
              {'y': -0.11864069952305246, 'waiting_time': 0.6666732237428654}),
             (-0.0625,
              {'y': -0.0375390015600624, 'waiting_time': 0.18445071536096025}),
             (0.25,
              {'y': 0.2515974440894569, 'waiting_time': 0.7141176528805409}),
             (-0.03125,
              {'y': 0.06163824383164006, 'waiting_time': 0.6933569860475436}),
             (0.125,
              {'y': 0.13135930047694755, 'waiting_time': 0.5884484185403707}),
             (-0.015625,
              {'y': 0.27495388762769585, 'waiting_time': 0.6953007750481064}),
             (0.0625,
              {'y': 0.0874609984399376, 'waiting_time': 0.7581916562241032}),
             (-0.0078125,
              {'y': 0.6131699135839903, 'waiting_time': 0.9021589650769567}),
             (0.015625,
              {'y': 0.30620388762769585, 'waiting_time': 0.17825373407874767}),
             (0.0078125,
              {'y': 0.6287949135839903, 'waiting_time': 0.1415731092538275}),
             (0.03125,
              {'y': 0.12413824383164006, 'waiting_time': 0.8795552706967087}),
             (-0.00390625,
              {'y': 0.8637065438995976, 'waiting_time': 0.49865901526026346}),
             (-0.625,
              {'y': -0.6247440655192271, 'waiting_time': 0.01926598082465858}),
             (0.00390625,
              {'y': 0.8715190438995976, 'waiting_time': 0.8362256134057106}),
             (0.875,
              {'y': 0.8751305951875673, 'waiting_time': 0.008304937785504007}),
             (0.625,
              {'y': 0.6252559344807729, 'waiting_time': 0.3777121247662958}),
             (-0.875,
              {'y': -0.8748694048124327, 'waiting_time': 0.8573956399009947}),
             (-0.01171875,
              {'y': 0.40963707758975415, 'waiting_time': 0.18575431286350252}),
             (0.01171875,
              {'y': 0.43307457758975415,
               'waiting_time': 0.024321008036004788}),
             (0.375,
              {'y': 0.3757106057914372, 'waiting_time': 0.7209898224409896}),
             (-0.005859375,
              {'y': 0.7385633611533918, 'waiting_time': 0.5850139258259234}),
             (-0.0234375,
              {'y': 0.1305706215220334, 'waiting_time': 0.2584614735044034}),
             (0.005859375,
              {'y': 0.7502821111533918, 'waiting_time': 0.6007608956069695}),
             (-0.009765625,
              {'y': 0.5020904154886127, 'waiting_time': 0.39186425133065017})])

1

This notebook can be downloaded as tutorial.DataSaver.ipynb and tutorial.DataSaver.md.