Add rst doc for ssd pytorch example #349
Conversation
Signed-off-by: Albert Wolant <awolant@nvidia.com>
awolant
changed the title
| Requirements | ||
| ------------ | ||
|
|
||
| - This example was tested with :bash:`python3.5.2` and it should work with later versions. It will not work with :bash:`python2.7` and earlier. |
There was a problem hiding this comment.
I have an impression, that this:
":bash:python3.5.2"
isn't displayed correctly. Could you verify?
Also it seems to be the case in some other places as well
There was a problem hiding this comment.
This is how it looks, I think it suffice.
There was a problem hiding this comment.
That's how it looks for me, maybe somebody else could verify?
There was a problem hiding this comment.
Yeah, picture I pasted was from doc generated locally using sphinx, I guess github does not handle rst files well. if you see other .rst files (like in resnet50 example) there are also problems there. I think maybe effort to make all docs look good in github should be separate from this PR? If indeed we do want to do it.
There was a problem hiding this comment.
This works well https://github.com/NVIDIA/DALI/blob/master/docs/examples/pytorch/renet50/pytorch-resnet50.rst. I think you can use different tag.
There was a problem hiding this comment.
Try to use:
.. code-block:: bash
Seems that this inline code doesn't work in the GitHub.
There was a problem hiding this comment.
This works well https://github.com/NVIDIA/DALI/blob/master/docs/examples/pytorch/renet50/pytorch-resnet50.rst. I think you can use different tag.
Under Training section there is :fileref: link visible, that is what I meant.
I will apply different method to highlight python versions.
There was a problem hiding this comment.
Done, inline highlighting looks good both in sphinx generated version and in github, using double grave accent method.
|
|
||
| .. code-block:: bash | ||
|
|
||
| python train.py |
There was a problem hiding this comment.
Could we somehow add also info, how to lunch it in distributed training manner? Like
python -m torch.distributed.launch --nproc_per_node=8 train.py
There was a problem hiding this comment.
Distributed run is not supported for this example for now.
| Single Shot MultiBox Detector training in PyTorch | ||
| ============================ | ||
|
|
||
| This example implements Single Shot Multibox Detector originally published by Wei Liu, Dragomir Anguelov, Dumitru Erhan, Christian Szegedy, |
There was a problem hiding this comment.
Pleaae stress out the purpose - to show how DALI works in the detection networks, not how to implement SSD itself. It will be included in DALI docs so it should be alligned with it.
Signed-off-by: Albert Wolant <awolant@nvidia.com>
Signed-off-by: Albert Wolant <awolant@nvidia.com>
|
Builds 40854 |
Signed-off-by: Albert Wolant <awolant@nvidia.com>
Signed-off-by: Albert Wolant <awolant@nvidia.com>
|
Builds 40867 |
* Added rst doc for ssd pytorch example Signed-off-by: Albert Wolant <awolant@nvidia.com> * Fix links names Signed-off-by: Albert Wolant <awolant@nvidia.com> * Fix example description Signed-off-by: Albert Wolant <awolant@nvidia.com> * Fix inline code for Github Signed-off-by: Albert Wolant <awolant@nvidia.com> * Fix python packages list display for Github Signed-off-by: Albert Wolant <awolant@nvidia.com>
Signed-off-by: Albert Wolant awolant@nvidia.com
Also remov old .md README and run_and_time.sh as it did not introduce anything usefull.