From e589069d3bdc8604a448d32d983c67a7d0013137 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Fri, 20 Dec 2024 23:47:23 +0000 Subject: [PATCH 01/13] Update desktop.rst --- docs/resources/desktop.rst | 79 +++++++++++++++++++++++++++++++++++++- 1 file changed, 78 insertions(+), 1 deletion(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index 2dd5d602..e7589a87 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -5,4 +5,81 @@ difPy for Desktop difPy for Desktop brings image deduplication as an easy to use app to your desktop. We are now accepting beta tester sign ups and will soon be starting our first tester access wave. -✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! \ No newline at end of file +✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! + +Installation +^^^^^^^^^^ + +difPy for desktop is available as beta version for Windows and Mac. + +➡️ Download difPy v1.0-beta for Windows (currently only available for beta testers) +➡️ Download difPy v1.0-beta for MacOs (currently only available for beta testers) + +Basic Usage +^^^^^^^^^^ + +The difPy search process is divided into two steps: import and search. First folders need to be selected an imported, and then the search must be configured and can be started. + +A new search can be started by clicking the "New Search" button in the center of the screen. + +Import Folders +++++++++++++ + +You can import one or more folders at once by clicking the "Browse" button. You can also paste folder paths (separated by ";") directly into the text box. + +When importing, you can select the following import modes: +* Recursive +* In-folder +* Pixel size (recommended not to change) + +**Recursive**: defines whether difPy should search through the subfolders of the selected folders. If checked, difPy will search for matches in all subfolders. + +**In-folder**: can only be selected if at least 2 folders have been imported. If selected, difPy will treat the folders as separate and only search for matches within the selected folders themselves. + +**Pixel size**: recommended not to change default value. Defines the width and height to which the images are compressed to before the search. The higher, the more precise but the slower the search. Default value is 50. If more precision is needed, incrementing in small steps of 50, starting with 100. + +Configure Search +++++++++++++ + +The difPy search can be configured to search for: +* duplicate or +* similar images + +**Duplicate**: When difPy searches for duplicates, it searches foe exact matches and the mean squared error (MSE) is set to 0. The result will only contain matches of images that are exact duplicates of each other. Whenever you are searching for duplicate images with different file formats (i. e. imageA.png is a duplicate of imageB.jpg), it is recommended to set the search similarity to "similar". + +**Similar**: When searching for similar images, the MSE is set to 5. The results will contain images that have a MSE of 5 or less (i. e. it will include duplicate matches and similar matches). + +.. note:: + Currently the similarity MSE value can not be customized in the desktop app. If you need a different MSE value, please use the command line version of difPy. + +**Rotate**: When configuring the search, you can also select whether to **rotate** the images on comparison or not. If selected, difPy will rotate the images by 90°, 180°, or 270° at each comparison. + +Advanced Settings +^^^^^^^^^^ + +From the difPy settings on the main menu, you can access advances search settings. + +.. warning:: + It is not recommended to change the advanced settings unless you know what you are doing. + +**Proceses**: Defines the maximum number of worker processes (i. e. parallel tasks) to perform when multiprocessing. The more processes, the faster the search, but the more processing power the app will use. See :ref:`processes` for more information. + +**Chunksize**: The number of image sets that should be compared at once per process. The higher the chunksize, the faster the search, but the more memory the app will use. See :ref:`chunksize` for more information. + +The ``process`` and ``chunksize`` are only used when difPy receives more than 5k images to process. With large datasets, it can make sense to adjust these parameters. For example, in order to lower the overall CPU overhead, you could lower ``processes``. In order to decrease memory usage, you could decrease ``chunksize``. The higher both parameters, the more performance you will gain, but the more resources the app will use. + +Limitations +^^^^^^^^^^ + +* Using the difPy desktop app for large datasets can lead to slower processing times. For better performance, with large datasets (> 10k images) it is recommended to use the command line version / Python package of difPy instead. See `here `_ for more information. + +* The desktop app is currently only available for Windows and Mac. + +* The desktop app is currently in beta and may contain bugs. If you encounter any issues, please report them on the GitHub repository. + +Give Reedback / Report Bug +^^^^^^^^^^ + +Did you encounter an issue with the difPy desktop app? 🐞 Please report it `here `_. \ No newline at end of file From 76ba34a53bdc4b8bd1ec6119479930697d2de977 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Fri, 20 Dec 2024 23:52:02 +0000 Subject: [PATCH 02/13] Update desktop.rst --- docs/resources/desktop.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index e7589a87..a721c8ae 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -12,8 +12,9 @@ Installation difPy for desktop is available as beta version for Windows and Mac. -➡️ Download difPy v1.0-beta for Windows (currently only available for beta testers) -➡️ Download difPy v1.0-beta for MacOs (currently only available for beta testers) +➡️ Download the difPy v1.0-beta app for Windows (*currently only available for beta testers*) + +➡️ Download the difPy v1.0-beta app for MacOs (*currently only available for beta testers*) Basic Usage ^^^^^^^^^^ @@ -77,7 +78,7 @@ Limitations * The desktop app is currently in beta and may contain bugs. If you encounter any issues, please report them on the GitHub repository. -Give Reedback / Report Bug +Give Feedback / Report Bug ^^^^^^^^^^ Did you encounter an issue with the difPy desktop app? 🐞 Please report it `here Date: Fri, 20 Dec 2024 23:54:18 +0000 Subject: [PATCH 03/13] Update desktop.rst --- docs/resources/desktop.rst | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index a721c8ae..0a09c3a9 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -19,7 +19,7 @@ difPy for desktop is available as beta version for Windows and Mac. Basic Usage ^^^^^^^^^^ -The difPy search process is divided into two steps: import and search. First folders need to be selected an imported, and then the search must be configured and can be started. +The difPy search process is divided into two steps: (1) import and (2) search. First folders need to be selected an imported, and then the search must be configured and can be started. A new search can be started by clicking the "New Search" button in the center of the screen. @@ -29,8 +29,11 @@ Import Folders You can import one or more folders at once by clicking the "Browse" button. You can also paste folder paths (separated by ";") directly into the text box. When importing, you can select the following import modes: + * Recursive + * In-folder + * Pixel size (recommended not to change) **Recursive**: defines whether difPy should search through the subfolders of the selected folders. If checked, difPy will search for matches in all subfolders. @@ -43,7 +46,9 @@ Configure Search ++++++++++++ The difPy search can be configured to search for: + * duplicate or + * similar images **Duplicate**: When difPy searches for duplicates, it searches foe exact matches and the mean squared error (MSE) is set to 0. The result will only contain matches of images that are exact duplicates of each other. Whenever you are searching for duplicate images with different file formats (i. e. imageA.png is a duplicate of imageB.jpg), it is recommended to set the search similarity to "similar". @@ -55,6 +60,14 @@ The difPy search can be configured to search for: **Rotate**: When configuring the search, you can also select whether to **rotate** the images on comparison or not. If selected, difPy will rotate the images by 90°, 180°, or 270° at each comparison. +Search Results +++++++++++++ + + +Image Viewer +++++++++++++ + + Advanced Settings ^^^^^^^^^^ From f99e516f3840bcfc90f69e09db995f19632786de Mon Sep 17 00:00:00 2001 From: elisemercury Date: Fri, 20 Dec 2024 23:55:11 +0000 Subject: [PATCH 04/13] Update desktop.rst --- docs/resources/desktop.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index 0a09c3a9..17835373 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -94,6 +94,6 @@ Limitations Give Feedback / Report Bug ^^^^^^^^^^ -Did you encounter an issue with the difPy desktop app? 🐞 Please report it `here `_. Do you have feedback about the difPy desktop app? Anything you think could be improved? 🗨️ Share your feedback with us `here `_. \ No newline at end of file From 2522fd8205028d1ad503bd5375f5df3718b5f968 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Sat, 21 Dec 2024 00:02:47 +0000 Subject: [PATCH 05/13] Update desktop.rst --- docs/resources/desktop.rst | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index 17835373..ef47cd6f 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -63,10 +63,24 @@ The difPy search can be configured to search for: Search Results ++++++++++++ +When difPy has completed the search, the results will be displayed, incl. the number of duplicate and/or similar matches it found. + +You can either: + +* **View the Search Logs** for more information about the search process + +* **View the Search Results** and manage your duplicate images in the difPy **Image Viewer**. See :ref:`image_viewer` for more information. + +.. _image_viewer: Image Viewer -++++++++++++ +^^^^^^^^^^ + +The difPy image viewer allows you to view the duplicate images and easily manage them. The Image Viewer lets you go through each group of matches, see the resolutions of each of the images so that you know which ones are safe to delete. + +For each image, you you have the option to open it, move them it a new folder, or delete it. +If you want to delete all lower resolution matches at once, you can use the "Bulk Actions..." dropdown menu and select the bulk action you would like to take. Advanced Settings ^^^^^^^^^^ From cb434556aae475e78d21e788d2cc9f92f435d783 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Sat, 21 Dec 2024 00:13:45 +0000 Subject: [PATCH 06/13] Update desktop.rst --- docs/resources/desktop.rst | 24 +++++++++++++++++++----- 1 file changed, 19 insertions(+), 5 deletions(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index ef47cd6f..5c845a01 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -1,11 +1,14 @@ .. _desktop: +.. note:: + ✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! + difPy for Desktop ---------------- difPy for Desktop brings image deduplication as an easy to use app to your desktop. We are now accepting beta tester sign ups and will soon be starting our first tester access wave. -✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! +.. _dsk_installation: Installation ^^^^^^^^^^ @@ -16,6 +19,8 @@ difPy for desktop is available as beta version for Windows and Mac. ➡️ Download the difPy v1.0-beta app for MacOs (*currently only available for beta testers*) +.. _dsk_basic_usage: + Basic Usage ^^^^^^^^^^ @@ -23,6 +28,8 @@ The difPy search process is divided into two steps: (1) import and (2) search. F A new search can be started by clicking the "New Search" button in the center of the screen. +.. _dsk_import: + Import Folders ++++++++++++ @@ -42,6 +49,8 @@ When importing, you can select the following import modes: **Pixel size**: recommended not to change default value. Defines the width and height to which the images are compressed to before the search. The higher, the more precise but the slower the search. Default value is 50. If more precision is needed, incrementing in small steps of 50, starting with 100. +.. _dsk_search: + Configure Search ++++++++++++ @@ -53,13 +62,12 @@ The difPy search can be configured to search for: **Duplicate**: When difPy searches for duplicates, it searches foe exact matches and the mean squared error (MSE) is set to 0. The result will only contain matches of images that are exact duplicates of each other. Whenever you are searching for duplicate images with different file formats (i. e. imageA.png is a duplicate of imageB.jpg), it is recommended to set the search similarity to "similar". -**Similar**: When searching for similar images, the MSE is set to 5. The results will contain images that have a MSE of 5 or less (i. e. it will include duplicate matches and similar matches). - -.. note:: - Currently the similarity MSE value can not be customized in the desktop app. If you need a different MSE value, please use the command line version of difPy. +**Similar**: When searching for similar images, the MSE is set to 5. The results will contain images that have a MSE of 5 or less (i. e. it will include duplicate matches and similar matches). Currently the similarity MSE value can not be customized in the desktop app. If you need a different MSE value, please use the command line version of difPy. **Rotate**: When configuring the search, you can also select whether to **rotate** the images on comparison or not. If selected, difPy will rotate the images by 90°, 180°, or 270° at each comparison. +.. _dsk_results: + Search Results ++++++++++++ @@ -82,6 +90,8 @@ For each image, you you have the option to open it, move them it a new folder, o If you want to delete all lower resolution matches at once, you can use the "Bulk Actions..." dropdown menu and select the bulk action you would like to take. +.. _dsk_advanced_settings: + Advanced Settings ^^^^^^^^^^ @@ -96,6 +106,8 @@ From the difPy settings on the main menu, you can access advances search setting The ``process`` and ``chunksize`` are only used when difPy receives more than 5k images to process. With large datasets, it can make sense to adjust these parameters. For example, in order to lower the overall CPU overhead, you could lower ``processes``. In order to decrease memory usage, you could decrease ``chunksize``. The higher both parameters, the more performance you will gain, but the more resources the app will use. +.. _dsk_limitations: + Limitations ^^^^^^^^^^ @@ -105,6 +117,8 @@ Limitations * The desktop app is currently in beta and may contain bugs. If you encounter any issues, please report them on the GitHub repository. +.. _dsk_feedback: + Give Feedback / Report Bug ^^^^^^^^^^ From 85228135e638c5ccff46ed935b47237be80d3510 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Sat, 21 Dec 2024 00:18:21 +0000 Subject: [PATCH 07/13] Update desktop.rst --- docs/resources/desktop.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index 5c845a01..79e0119c 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -77,18 +77,18 @@ You can either: * **View the Search Logs** for more information about the search process -* **View the Search Results** and manage your duplicate images in the difPy **Image Viewer**. See :ref:`image_viewer` for more information. +* **View the Search Results** and manage your duplicate images in the difPy **Image Viewer**. See :ref:`dsk_image_viewer` for more information. -.. _image_viewer: +.. _dsk_image_viewer: Image Viewer ^^^^^^^^^^ -The difPy image viewer allows you to view the duplicate images and easily manage them. The Image Viewer lets you go through each group of matches, see the resolutions of each of the images so that you know which ones are safe to delete. +The difPy image viewer allows you to view the duplicate images and easily manage them. The Image Viewer lets you go through each group of matches, see the resolutions of each of the images so that you know which ones are safe to be deleted. -For each image, you you have the option to open it, move them it a new folder, or delete it. +For each image, you have the option to open it, move it a new location, or delete it. -If you want to delete all lower resolution matches at once, you can use the "Bulk Actions..." dropdown menu and select the bulk action you would like to take. +If you want to move or delete all lower resolution matches at once, you can use the "Bulk Actions..." dropdown menu and select the bulk action you would like to take. .. _dsk_advanced_settings: @@ -115,7 +115,7 @@ Limitations * The desktop app is currently only available for Windows and Mac. -* The desktop app is currently in beta and may contain bugs. If you encounter any issues, please report them on the GitHub repository. +* The desktop app is currently in beta and may contain bugs. If you encounter any issues, please report it. See :ref:`dsk_feedback`. .. _dsk_feedback: From 7e2675aa6533be8b4634aabdbf7fc0735e4c5a2b Mon Sep 17 00:00:00 2001 From: elisemercury Date: Thu, 2 Jan 2025 17:25:48 +0100 Subject: [PATCH 08/13] Updated links --- docs/resources/desktop.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index 79e0119c..ebe50604 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -1,7 +1,7 @@ .. _desktop: .. note:: - ✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! + ✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! difPy for Desktop ---------------- @@ -13,11 +13,11 @@ difPy for Desktop brings image deduplication as an easy to use app to your deskt Installation ^^^^^^^^^^ -difPy for desktop is available as beta version for Windows and Mac. +difPy for desktop is available as beta version for Windows. ➡️ Download the difPy v1.0-beta app for Windows (*currently only available for beta testers*) -➡️ Download the difPy v1.0-beta app for MacOs (*currently only available for beta testers*) +➡️ Download the difPy v1.0-beta app for MacOs (*coming soon*) .. _dsk_basic_usage: @@ -122,6 +122,6 @@ Limitations Give Feedback / Report Bug ^^^^^^^^^^ -Did you encounter an issue with the difPy desktop app? 🐞 Please report it `here `_. +Did you encounter an issue with the difPy desktop app? 🐞 Please report it `here `_. -Do you have feedback about the difPy desktop app? Anything you think could be improved? 🗨️ Share your feedback with us `here `_. \ No newline at end of file +Do you have feedback about the difPy desktop app? Anything you think could be improved? 🗨️ Share your feedback with us `here `_. \ No newline at end of file From a26be2fadaac82cc84b6eafab325a8f15979b01f Mon Sep 17 00:00:00 2001 From: elisemercury Date: Thu, 2 Jan 2025 19:22:54 +0100 Subject: [PATCH 09/13] Update desktop.rst --- docs/resources/desktop.rst | 74 +++++++++++++++++++------------------- 1 file changed, 37 insertions(+), 37 deletions(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index ebe50604..f5a43f4b 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -1,108 +1,108 @@ .. _desktop: .. note:: - ✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! + ✨🚀 `Join the difPy for Desktop beta tester program `_ now and be among to first to test the new difPy desktop app! We are now accepting beta tester sign ups and will soon be starting our first tester access wave. difPy for Desktop ---------------- -difPy for Desktop brings image deduplication as an easy to use app to your desktop. We are now accepting beta tester sign ups and will soon be starting our first tester access wave. +difPy for Desktop brings difPy's image deduplication capabilities as an intuitive, easy to use app to your desktop. + +Unlike most deduplication software, difPy does **not** compare images based on their hashes - it compares them based on their **image tensors** (i. e. the actual image content). This allows difPy to not only search for exact **duplicate images**, but also for **similar images** (which can be very useful if duplicate images have different file extensions, or if images are cropped versions of one another). .. _dsk_installation: Installation ^^^^^^^^^^ -difPy for desktop is available as beta version for Windows. - -➡️ Download the difPy v1.0-beta app for Windows (*currently only available for beta testers*) +➡️ Download the difPy v1.0-beta app for **Windows** (*currently available for beta testers*) -➡️ Download the difPy v1.0-beta app for MacOs (*coming soon*) +➡️ Download the difPy v1.0-beta app for **MacOS** (*coming soon*) .. _dsk_basic_usage: Basic Usage ^^^^^^^^^^ -The difPy search process is divided into two steps: (1) import and (2) search. First folders need to be selected an imported, and then the search must be configured and can be started. - -A new search can be started by clicking the "New Search" button in the center of the screen. +To start a new search, open the difPy for Desktop app and click the "New Search". The search process is divided into two steps: (1) import folders and (2) configure search. .. _dsk_import: Import Folders ++++++++++++ -You can import one or more folders at once by clicking the "Browse" button. You can also paste folder paths (separated by ";") directly into the text box. - -When importing, you can select the following import modes: +You can import **one or more folders** at once by clicking the "Browse" button. Alternatively, you can also paste folder paths (separated by a semicolon ";") directly into the text box. -* Recursive +The following import modes are supported: -* In-folder +* **Recursive**: defines whether difPy should search through the subfolder(s) of the imported folder. If selected, difPy will search for matches in all subfolders. -* Pixel size (recommended not to change) +* **In-folder**: defines whether difPy should treat each folder as separate and only search for matches among the folder itself. If selected, difPy will treat the folders as separate. **Can only be selected if at least 2 folders have been imported**. -**Recursive**: defines whether difPy should search through the subfolders of the selected folders. If checked, difPy will search for matches in all subfolders. +Additionally, you can configure the following advanced import settings: -**In-folder**: can only be selected if at least 2 folders have been imported. If selected, difPy will treat the folders as separate and only search for matches within the selected folders themselves. - -**Pixel size**: recommended not to change default value. Defines the width and height to which the images are compressed to before the search. The higher, the more precise but the slower the search. Default value is 50. If more precision is needed, incrementing in small steps of 50, starting with 100. +**Pixel size**: defines the width and height to which the images are compressed to before the search (default value is 50). The higher the pixel size, the more precise but the slower the search. **It is recommended not to change the default value. Only change this value if you know what you are doing**. If you would like to improve the precision of the search (f. e. when you are searching for matches among images that contain text), it is recommended to increment this value by steps of 50. .. _dsk_search: Configure Search ++++++++++++ -The difPy search can be configured to search for: +After importing the folder(s), you can configure what type of similarity search difPy should perform. difPy can search for: * duplicate or * similar images -**Duplicate**: When difPy searches for duplicates, it searches foe exact matches and the mean squared error (MSE) is set to 0. The result will only contain matches of images that are exact duplicates of each other. Whenever you are searching for duplicate images with different file formats (i. e. imageA.png is a duplicate of imageB.jpg), it is recommended to set the search similarity to "similar". +**Duplicate**: when the search is set to "duplicates", difPy searches for **exact image matches**. The result will only contain matches of images that are exact duplicates of each other. Whenever you are searching for duplicate images with different file formats (i. e. imageA.png is a duplicate of imageB.jpg), it is recommended to set the search similarity to "similar". + +**Similar**: when the search is set to "similar", the results will include **duplicate and similar image matches**. + +.. note:: + **How does similarity search work?** + difPy compares the images pixel by pixel and calculates the Mean Squared Error (MSE) between the images. The MSE is a measure of the similarity between two images. The lower the MSE value, the more similar the images are. When similarity is set to "duplicates", difPy will only return matches with an MSE value of 0. When similarity is set to "similar", difPy will return matches with an MSE value of 5 or lower. Currently the similarity MSE value can not be customized in the desktop app. If you need a different MSE value, please use the `difPy Python package / Command Line Version `_. -**Similar**: When searching for similar images, the MSE is set to 5. The results will contain images that have a MSE of 5 or less (i. e. it will include duplicate matches and similar matches). Currently the similarity MSE value can not be customized in the desktop app. If you need a different MSE value, please use the command line version of difPy. +Additionally, you can configure the following advanced search settings: -**Rotate**: When configuring the search, you can also select whether to **rotate** the images on comparison or not. If selected, difPy will rotate the images by 90°, 180°, or 270° at each comparison. +**Rotate**: if selected, difPy will rotate the images by 90°, 180°, or 270° at each comparison. This is useful if you know that the duplicate/similar images you are looking for are rotated. .. _dsk_results: Search Results ++++++++++++ -When difPy has completed the search, the results will be displayed, incl. the number of duplicate and/or similar matches it found. +When difPy has completed the search, the search results will be displayed, incl. the number of duplicate and/or similar matches it found. -You can either: +You can then: -* **View the Search Logs** for more information about the search process +* **View/manage the search results** in the **difPy Image Viewer** (see :ref:`dsk_image_viewer`). -* **View the Search Results** and manage your duplicate images in the difPy **Image Viewer**. See :ref:`dsk_image_viewer` for more information. +* **View the search logs** for more information about the search process. .. _dsk_image_viewer: Image Viewer ^^^^^^^^^^ -The difPy image viewer allows you to view the duplicate images and easily manage them. The Image Viewer lets you go through each group of matches, see the resolutions of each of the images so that you know which ones are safe to be deleted. +The difPy image viewer allows you to view the duplicate/similar images and easily manage them. The Image Viewer lets you go through each group of matches and see the resolutions of each of the images so that you know which ones are safe to be moved or deleted. -For each image, you have the option to open it, move it a new location, or delete it. +For each image, you have the option to **open it**, **move it** to a new location, or **delete it**. -If you want to move or delete all lower resolution matches at once, you can use the "Bulk Actions..." dropdown menu and select the bulk action you would like to take. +If you want to **move or delete all** lower resolution matches at once, you can use the "Bulk Actions..." dropdown menu and select the bulk action you would like to take. .. _dsk_advanced_settings: Advanced Settings ^^^^^^^^^^ -From the difPy settings on the main menu, you can access advances search settings. +From the difPy settings on the main menu, you can access advanced search settings. .. warning:: It is not recommended to change the advanced settings unless you know what you are doing. -**Proceses**: Defines the maximum number of worker processes (i. e. parallel tasks) to perform when multiprocessing. The more processes, the faster the search, but the more processing power the app will use. See :ref:`processes` for more information. +**Proceses**: defines the maximum number of worker processes (i. e. parallel tasks) to perform when multiprocessing. The more processes, the faster the search, but the more processing power the app will use. See :ref:`processes` for more information. -**Chunksize**: The number of image sets that should be compared at once per process. The higher the chunksize, the faster the search, but the more memory the app will use. See :ref:`chunksize` for more information. +**Chunksize**: defines the number of image sets that should be compared at once per process. The higher the chunksize, the faster the search, but the more memory the app will use. See :ref:`chunksize` for more information. The ``process`` and ``chunksize`` are only used when difPy receives more than 5k images to process. With large datasets, it can make sense to adjust these parameters. For example, in order to lower the overall CPU overhead, you could lower ``processes``. In order to decrease memory usage, you could decrease ``chunksize``. The higher both parameters, the more performance you will gain, but the more resources the app will use. @@ -111,9 +111,9 @@ The ``process`` and ``chunksize`` are only used when difPy receives more than 5k Limitations ^^^^^^^^^^ -* Using the difPy desktop app for large datasets can lead to slower processing times. For better performance, with large datasets (> 10k images) it is recommended to use the command line version / Python package of difPy instead. See `here `_ for more information. +* Using the difPy desktop app for large datasets can lead to slower processing times. For better performance, with large datasets (> 10k images) it is recommended to use the `difPy Python package / Command Line Version `_. instead. -* The desktop app is currently only available for Windows and Mac. +* The desktop app is currently only available to beta testers on Windows. * The desktop app is currently in beta and may contain bugs. If you encounter any issues, please report it. See :ref:`dsk_feedback`. @@ -122,6 +122,6 @@ Limitations Give Feedback / Report Bug ^^^^^^^^^^ -Did you encounter an issue with the difPy desktop app? 🐞 Please report it `here `_. +🐞 Did you encounter an issue with the difPy desktop app? Please report it `here `_. -Do you have feedback about the difPy desktop app? Anything you think could be improved? 🗨️ Share your feedback with us `here `_. \ No newline at end of file +🗨️ Do you have feedback about the difPy desktop app? Anything you think could be improved? Share your feedback with us `here `_. \ No newline at end of file From 6f804e406d0629152c9898e959ac6259a59d1856 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Thu, 2 Jan 2025 19:23:58 +0100 Subject: [PATCH 10/13] Update desktop.rst --- docs/resources/desktop.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index f5a43f4b..3a6e60b0 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -100,7 +100,7 @@ From the difPy settings on the main menu, you can access advanced search setting .. warning:: It is not recommended to change the advanced settings unless you know what you are doing. -**Proceses**: defines the maximum number of worker processes (i. e. parallel tasks) to perform when multiprocessing. The more processes, the faster the search, but the more processing power the app will use. See :ref:`processes` for more information. +**Processes**: defines the maximum number of worker processes (i. e. parallel tasks) to perform when multiprocessing. The more processes, the faster the search, but the more processing power the app will use. See :ref:`processes` for more information. **Chunksize**: defines the number of image sets that should be compared at once per process. The higher the chunksize, the faster the search, but the more memory the app will use. See :ref:`chunksize` for more information. From d2a72ad5d665a054fe2d5c650ed3995b17f0965a Mon Sep 17 00:00:00 2001 From: elisemercury Date: Thu, 2 Jan 2025 19:25:44 +0100 Subject: [PATCH 11/13] Update desktop.rst --- docs/resources/desktop.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/resources/desktop.rst b/docs/resources/desktop.rst index 3a6e60b0..8283dc2f 100644 --- a/docs/resources/desktop.rst +++ b/docs/resources/desktop.rst @@ -124,4 +124,4 @@ Give Feedback / Report Bug 🐞 Did you encounter an issue with the difPy desktop app? Please report it `here `_. -🗨️ Do you have feedback about the difPy desktop app? Anything you think could be improved? Share your feedback with us `here `_. \ No newline at end of file +🗨️ Do you have feedback about the difPy desktop app? Share your feedback with us `here `_. \ No newline at end of file From 2b057febf6287836175e4c4083ca5efb2e8ae970 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Fri, 3 Jan 2025 00:03:11 +0100 Subject: [PATCH 12/13] Update search.rst --- docs/methods/search.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/methods/search.rst b/docs/methods/search.rst index f1ae82c7..75c75122 100644 --- a/docs/methods/search.rst +++ b/docs/methods/search.rst @@ -48,7 +48,7 @@ difPy compares the images to find duplicates or similarities, based on the MSE ( The search for similar images can be useful when searching for duplicate files that might have different file **types** (i. e. imageA.png has a duplicate imageA.jpg) and/or different file **sizes** (f. e. imageA.png (100MB) has a duplicate imageA.png (50MB)). In these cases, the MSE between the two image tensors might not be exactly == 0, hence they would not be classified as being duplicates even though in reality they are. Setting ``similarity`` to ``"similar"`` searches for duplicates with a certain tolerance, increasing the likelihood of finding duplicate images of different file types and sizes. Depending on which ``similarity`` level is chosen, the ``lazy`` parameter should be adjusted accordingly (see :ref:`lazy`). -.. figure:: static/assets/choosing_similarity.png +.. figure:: ./static/assets/choosing_similarity.png :width: 540 :height: 390 :alt: Setting the "similarity" & "lazy" Parameter From f37357f6d79ce95374b542c8a9d6f50c067a6009 Mon Sep 17 00:00:00 2001 From: elisemercury Date: Fri, 3 Jan 2025 00:05:34 +0100 Subject: [PATCH 13/13] Update search.rst --- docs/methods/search.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/methods/search.rst b/docs/methods/search.rst index 75c75122..d2b34bd6 100644 --- a/docs/methods/search.rst +++ b/docs/methods/search.rst @@ -48,7 +48,7 @@ difPy compares the images to find duplicates or similarities, based on the MSE ( The search for similar images can be useful when searching for duplicate files that might have different file **types** (i. e. imageA.png has a duplicate imageA.jpg) and/or different file **sizes** (f. e. imageA.png (100MB) has a duplicate imageA.png (50MB)). In these cases, the MSE between the two image tensors might not be exactly == 0, hence they would not be classified as being duplicates even though in reality they are. Setting ``similarity`` to ``"similar"`` searches for duplicates with a certain tolerance, increasing the likelihood of finding duplicate images of different file types and sizes. Depending on which ``similarity`` level is chosen, the ``lazy`` parameter should be adjusted accordingly (see :ref:`lazy`). -.. figure:: ./static/assets/choosing_similarity.png +.. figure:: docs/static/assets/choosing_similarity.png :width: 540 :height: 390 :alt: Setting the "similarity" & "lazy" Parameter