Skip to content

Commit 0a13c8a

Browse files
author
Yue Tu
committed
address one more comment about documentation
1 parent e34d726 commit 0a13c8a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

doc/overview.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -191,9 +191,9 @@ when creating an ``Estimator`` object. If Git support is enabled, then ``entry_p
191191
should be relative paths in the Git repo if provided.
192192

193193
The ``git_config`` parameter includes fields ``repo``, ``branch``, ``commit``, ``2FA_enabled``, ``username``,
194-
``password`` and ``token``. The ``repo`` field is required. All other fields are optional. ``repo`` specifies the Git repository
195-
that you want to use. If ``branch`` is not provided, master branch will be used. If ``commit`` is not provided,
196-
the latest commit in the required branch will be used.
194+
``password`` and ``token``. The ``repo`` field is required. All other fields are optional. ``repo`` specifies the Git
195+
repository where your training script is stored. If you don't provide ``branch``, the default value 'master' is used.
196+
If you don't provide ``commit``, the latest commit in the specified branch is used.
197197

198198
``2FA_enabled``, ``username``, ``password`` and ``token`` are used for authentication. Set ``2FA_enabled`` to 'True' if
199199
two-factor authentication is enabled for the GitHub (or other Git) account, otherwise set it to 'False'.

0 commit comments

Comments
 (0)