Skip to content

[docs] add submodule in engine.rst #1464

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Nov 19, 2020
Merged

[docs] add submodule in engine.rst #1464

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f2ba0a4
Update setup.cfg
Oct 24, 2020
24669e6
Merge remote-tracking branch 'upstream/master'
Nov 11, 2020
571a130
Merge remote-tracking branch 'upstream/master'
Nov 12, 2020
b995b69
Merge remote-tracking branch 'upstream/master'
Nov 14, 2020
b45e31d
Merge remote-tracking branch 'upstream/master'
Nov 15, 2020
e6e6ec2
[docs] add submodule in engine
Nov 15, 2020
5f71856
Merge branch 'master' into docs-engine
Nov 15, 2020
3b99a67
[docs] add suggestions, contrib engine docs and 45% width
Nov 16, 2020
6aaaa3c
Update ignite_theme.css
Nov 16, 2020
a05ede4
Merge branch 'master' into docs-engine
Nov 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 17 additions & 10 deletions docs/source/_templates/_static/css/ignite_theme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
article.pytorch-article table tr th:first-of-type, article.pytorch-article table tr td:first-of-type
{
article.pytorch-article table tr th:first-of-type,
article.pytorch-article table tr td:first-of-type {
width: 17px;
}

div.container a.header-logo
{
div.container a.header-logo {
height: 80px;
width: 160px;
background-image: url("../img/ignite_logo.svg");
Expand Down Expand Up @@ -68,7 +67,8 @@ div.container a.header-logo
text-decoration: none;
}

.rst-versions .rst-current-version:after, .rst-versions .rst-current-version:before {
.rst-versions .rst-current-version:after,
.rst-versions .rst-current-version:before {
display: table;
content: "";
}
Expand All @@ -79,15 +79,17 @@ div.container a.header-logo
display: block;
}

.rst-versions .rst-current-version .fa-book, .rst-versions .rst-current-version .icon-book {
.rst-versions .rst-current-version .fa-book,
.rst-versions .rst-current-version .icon-book {
float: left;
}

.rst-versions .rst-current-version .fa {
color: #454545;
}

.rst-versions .rst-current-version .fa-book, .rst-versions .rst-current-version .icon-book {
.rst-versions .rst-current-version .fa-book,
.rst-versions .rst-current-version .icon-book {
float: left;
}

Expand All @@ -114,7 +116,9 @@ div.container a.header-logo
color: #ee4c2c;
}

.fa:before, a .fa, li .fa {
.fa:before,
a .fa,
li .fa {
text-decoration: inherit;
}

Expand All @@ -131,8 +135,11 @@ article.pytorch-article table.longtable.docutils.align-default colgroup {
display: none;
}

article.pytorch-article table.longtable.docutils.align-default tbody td:first-child {
width: 30%;
article.pytorch-article
table.longtable.docutils.align-default
tbody
td:first-child {
width: 40%;
}

article.pytorch-article table.longtable.docutils.align-default tbody td {
Expand Down
6 changes: 4 additions & 2 deletions docs/source/contrib/engines.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,18 @@
ignite.contrib.engines
======================

Contribution module of engines and helper tools
Contribution module of engines and helper tools:

.. currentmodule:: ignite.contrib.engines
ignite.contrib.engines.tbptt

.. currentmodule:: ignite.contrib.engines.tbptt

.. autosummary::
:nosignatures:
:autolist:

ignite.contrib.engines.common

.. currentmodule:: ignite.contrib.engines.common

.. autosummary::
Expand Down
9 changes: 7 additions & 2 deletions docs/source/engine.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,25 +3,31 @@ ignite.engine

Main module of the library containing:

ignite.engine.engine

.. currentmodule:: ignite.engine.engine

.. autosummary::
:nosignatures:
:autolist:

ignite.engine.events

.. currentmodule:: ignite.engine.events

.. autosummary::
:nosignatures:
:autolist:

ignite.engine.deterministic (helper methods for deterministic training)

.. currentmodule:: ignite.engine.deterministic

.. autosummary::
:nosignatures:
:autolist:

and helper methods:
and helper methods to define supervised trainer and evaluator:

.. currentmodule:: ignite.engine

Expand Down Expand Up @@ -296,4 +302,3 @@ here:
# handler synchronizes the random state
torch.manual_seed(12)
a = torch.rand(1)