-
Notifications
You must be signed in to change notification settings - Fork 31
/
callback.py
82 lines (65 loc) · 2.52 KB
/
callback.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
# Copyright 2018 PIQuIL - All Rights Reserved
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
# http://www.apache.org/licenses/LICENSE-2.0
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
class Callback:
"""Base class for callbacks."""
def on_train_start(self, nn_state):
"""Called at the start of the training cycle.
:param nn_state: The Wavefunction being trained.
:type nn_state: Wavefunction
"""
pass
def on_train_end(self, nn_state):
"""Called at the end of the training cycle.
:param nn_state: The Wavefunction being trained.
:type nn_state: Wavefunction
"""
pass
def on_epoch_start(self, nn_state, epoch):
"""Called at the start of each epoch.
:param nn_state: The Wavefunction being trained.
:type nn_state: Wavefunction
:param epoch: The current epoch.
:type epoch: int
"""
pass
def on_epoch_end(self, nn_state, epoch):
"""Called at the end of each epoch.
:param nn_state: The Wavefunction being trained.
:type nn_state: Wavefunction
:param epoch: The current epoch.
:type epoch: int
"""
pass
def on_batch_start(self, nn_state, epoch, batch):
"""Called at the start of each batch.
:param nn_state: The Wavefunction being trained.
:type nn_state: Wavefunction
:param epoch: The current epoch.
:type epoch: int
:param batch: The current batch index.
:type batch: int
"""
pass
def on_batch_end(self, nn_state, epoch, batch):
"""Called at the end of each batch.
:param nn_state: The Wavefunction being trained.
:type nn_state: Wavefunction
:param epoch: The current epoch.
:type epoch: int
:param batch: The current batch index.
:type batch: int
"""
pass