Skip to content

Commit 47e7734

Browse files
committed
Minor updates to docs
1 parent 7389ccb commit 47e7734

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/faq.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ FAQ
88
What's new in v4?
99
----------------
1010

11-
difPy version 4 is the next-generation version of difPy, which not only achieves **up to 10x the performance** compared to version 3.x, but also comes with a variety of **new features** that make it's usage experience even better.
11+
difPy version 4 is the next-generation version of difPy, which not only achieves **up to 10x the performance** compared to version 3.x, but also comes with a variety of **new features** that make its usage experience even better.
1212

1313
**Splitting of Processes**
1414

@@ -61,7 +61,7 @@ difPy will then initiate a search for each separate folder considering them as s
6161

6262
**difPy is more Lightweight**
6363

64-
The difPy is now much more lightweight by depending less on external packages, and more on Python native features. Moreover, difPy processes certain functions more efficiently thanks to increased usage of `Numpy <https://www.geeksforgeeks.org/why-numpy-is-faster-in-python/>`_.
64+
difPy is now much more lightweight by depending less on external packages, and more on Python native features. Moreover, difPy processes certain functions more efficiently thanks to increased usage of `Numpy <https://www.geeksforgeeks.org/why-numpy-is-faster-in-python/>`_.
6565

6666
.. _Supported File Types:
6767

docs/parameters.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Parameters
77
difPy.build
88
------------
99

10-
Before difPy can perform any search, it needs to build it's image repository and transform the images in the provided directory into tensors. This is what is done when ``difPy.build()`` is invoked.
10+
Before difPy can perform any search, it needs to build its image repository and transform the images in the provided directory into tensors. This is what is done when ``difPy.build()`` is invoked.
1111

1212
Upon completion, ``difPy.build()`` returns a ``dif`` object that can be used in :ref:`difPy.search` to start the search process.
1313

@@ -189,7 +189,7 @@ Depending on which use case you want to apply difPy for, the granularity for the
189189

190190
**Manual setting**: the match MSE threshold can be adjusted manually by setting the ``similarity`` parameter to any ``int`` or ``float``. difPy will then search for images that match an MSE threshold **equal to or lower than** the one specified.
191191

192-
When searching for **similar** images, the choice of MSE threshold becomes very important. A threshold of ``50`` will usually find similarities in regular photographs well, but if applied to images containing for example text with a plain white background, an MSE threshold of ``50`` will usually be too high and difPy will consider all images to be similar, even though they are not. In this case, for more precision, the ``similarity`` parameter should be lowered. Additionally, the ``px_size`` parameter can also be lowered to gain more precision (see :ref:`px_size`).
192+
When searching for **similar** images, the choice of MSE threshold becomes very important. A threshold of ``50`` will usually find similarities in regular photographs well, but if applied to images containing for example text with a plain white background, an MSE threshold of ``50`` will usually be too high and difPy will consider all images to be similar, even though they are not. In this case, for more precision, the ``similarity`` parameter should be lowered. Additionally, the ``px_size`` parameter can also be increased to gain more precision (see :ref:`px_size`).
193193

194194
.. _show_progress:
195195

docs/usage.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ difPy can be invoked through a CLI interface by using the following commands:
7979
8080
.. note::
8181

82-
Windows users can add difPy to their `PATH system variables <https://www.computerhope.com/issues/ch000549.htm>`_ by pointing it to their difPy package installation folder containing the `difPy.bat <https://github.com/elisemercury/Duplicate-Image-Finder/difPy/difPy.bat>`_ file. This adds ``difPy`` as a command in the CLI and will allow direct invocation of difPy from anywhere on the machine. The default difPy installation folder will look similar to ``C:\Users\User\AppData\Local\Programs\Python\Python311\Lib\site-packages\difPy`` (Windows 11).
82+
Windows users can add difPy to their `PATH system variables <https://www.computerhope.com/issues/ch000549.htm>`_ by pointing it to their difPy package installation folder containing the `difPy.bat <https://github.com/elisemercury/Duplicate-Image-Finder/blob/main/difPy/difPy.bat>`_ file. This adds ``difPy`` as a command in the CLI and will allow direct invocation of difPy from anywhere on the machine. The default difPy installation folder will look similar to ``C:\Users\User\AppData\Local\Programs\Python\Python311\Lib\site-packages\difPy`` (Windows 11).
8383

8484
difPy in the CLI supports the following arguments:
8585

0 commit comments

Comments
 (0)