Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.8/site-packages/tensorflow/python/training/basic_loops.py: 28%

1# Copyright 2016 The TensorFlow Authors. All Rights Reserved. 

2# 

3# Licensed under the Apache License, Version 2.0 (the "License"); 

4# you may not use this file except in compliance with the License. 

5# You may obtain a copy of the License at 

6# 

7# http://www.apache.org/licenses/LICENSE-2.0 

8# 

9# Unless required by applicable law or agreed to in writing, software 

10# distributed under the License is distributed on an "AS IS" BASIS, 

11# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 

12# See the License for the specific language governing permissions and 

13# limitations under the License. 

14# ============================================================================== 

15"""Basic loop for training.""" 

16from tensorflow.python.framework import errors 

17from tensorflow.python.util.tf_export import tf_export 

18 

19 

20@tf_export(v1=["train.basic_train_loop"]) 

21def basic_train_loop(supervisor, 

22 train_step_fn, 

23 args=None, 

24 kwargs=None, 

25 master=""): 

26 """Basic loop to train a model. 

27 

28 Calls `train_step_fn` in a loop to train a model. The function is called as: 

29 

30 ```python 

31 train_step_fn(session, *args, **kwargs) 

32 ``` 

33 

34 It is passed a `tf.compat.v1.Session` in addition to `args` and `kwargs`. The 

35 function 

36 typically runs one training step in the session. 

37 

38 Args: 

39 supervisor: `tf.compat.v1.train.Supervisor` to run the training services. 

40 train_step_fn: Callable to execute one training step. Called repeatedly as 

41 `train_step_fn(session, *args **kwargs)`. 

42 args: Optional positional arguments passed to `train_step_fn`. 

43 kwargs: Optional keyword arguments passed to `train_step_fn`. 

44 master: Master to use to create the training session. Defaults to `""` 

45 which causes the session to be created in the local process. 

46 """ 

47 if args is None: 

48 args = [] 

49 if kwargs is None: 

50 kwargs = {} 

51 should_retry = True 

52 while should_retry: 

53 try: 

54 should_retry = False 

55 with supervisor.managed_session(master) as sess: 

56 while not supervisor.should_stop(): 

57 train_step_fn(sess, *args, **kwargs) 

58 except errors.AbortedError: 

59 # Always re-run on AbortedError as it indicates a restart of one of the 

60 # distributed tensorflow servers. 

61 should_retry = True