Skip to content

Commit

Permalink
update docstring for train_noise
Browse files Browse the repository at this point in the history
  • Loading branch information
Lixin Sun committed Nov 19, 2019
1 parent 7840fe4 commit 0febc3c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions flare/mc_sephyps.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,23 @@
read [0,1,1,1,1,1,1,1]. The user should make sure that the mask has
a permutational symmetry.
For selective optimization. one can define 'map', 'train_noise' and 'original'
to identify which element to be optimized. All three have to be defined.
Example, the full set of hyper parmeters include [ls21, ls22, sig21, sig22, ls3
sg3, noise] and only the set 21 is optimized. Then
hyps = [ls21, sig21]
hyps_mask = { ..., 'train_noise': False, 'map':[0, 2],
'original': [ls21, ls22, sig21, sig22, ls3, sg3, noise]}
the hyps argument should only contain the values that need to be optimized.
train_noise = Bool (True/False), whether the noise parameter can be optimized
original: np.array. Full set of hyperparmeters
map: np.array, array to map the hyper parameter back to the full set.
map[i]=j means the i-th element in hyps should be
the j-th element in hyps_mask['original']
"""


Expand Down

0 comments on commit 0febc3c

Please sign in to comment.