Skip to content

Commit

Permalink
Address small nits in the docs (facebookresearch#156)
Browse files Browse the repository at this point in the history
Summary: Pull Request resolved: facebookresearch#156

Reviewed By: bottler

Differential Revision: D26112284

Pulled By: prigoyal

fbshipit-source-id: 257fff1ab410616ea46d0ff20c1355d8631d8267
  • Loading branch information
prigoyal authored and facebook-github-bot committed Jan 28, 2021
1 parent 60ad4fa commit ab44d01
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ make sure to have a corresponding issue to discuss your motivation and proposals
before sending a PR. We do not always accept new features, and we take the following
factors into consideration:

1. Whether the same feature can be achieved without modifying vissl.VISSL is designed to be extensible so that it's easy to extend any modular component and train custom models. If some part is not as extensible, you can also bring up the issue to make it more extensible.
1. Whether the same feature can be achieved without modifying VISSL. VISSL is designed to be extensible so that it's easy to extend any modular component and train custom models. If some part is not as extensible, you can also bring up the issue to make it more extensible.
2. Whether the feature is potentially useful to a large audience, or only to a small portion of users.
3. Whether the proposed solution has a good design / interface.
4. Whether the proposed solution adds extra mental/practical overhead to users who don't need such feature.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/hydra_config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ For example:
How to add new keys to the dictionary in config files
------------------------------------------------------

If you want to add single key to a dictionary in the config, you can achieve that with :code:`+my_new_key_name=my_value`. Note the use if :code:`+`.
If you want to add single key to a dictionary in the config, you can achieve that with :code:`+my_new_key_name=my_value`. Note the use of :code:`+`.

For example:

Expand Down
14 changes: 7 additions & 7 deletions docs/source/ssl_approaches/clusterfit.rst
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,11 @@ Citation

.. code-block:: none
@misc{gidaris2018unsupervised,
title={Unsupervised Representation Learning by Predicting Image Rotations},
author={Spyros Gidaris and Praveer Singh and Nikos Komodakis},
year={2018},
eprint={1803.07728},
archivePrefix={arXiv},
primaryClass={cs.CV}
@misc{yan2019clusterfit,
title={ClusterFit: Improving Generalization of Visual Representations},
author={Xueting Yan and Ishan Misra and Abhinav Gupta and Deepti Ghadiyaram and Dhruv Mahajan},
year={2019},
eprint={1912.03330},
archivePrefix={arXiv},
primaryClass={cs.CV}
}

0 comments on commit ab44d01

Please sign in to comment.