Skip to content

Commit 380afd3

Browse files
authored
Merge pull request #215 from dnth/readme-update
Readme updates
2 parents ce5a2b9 + 422f2fc commit 380afd3

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
<a href="https://twitter.com/visual_layer" target="_blank" rel="noopener noreferrer">
6969
<img src="https://img.shields.io/badge/Twitter-1DA1F2?style=for-the-badge&logo=twitter&logoColor=white" alt="Logo">
7070
</a>
71-
<a href="https://www.youtube.com/@visual-layer4035" target="_blank" rel="noopener noreferrer">
71+
<a href="https://www.youtube.com/@visual-layer" target="_blank" rel="noopener noreferrer">
7272
<img src="https://img.shields.io/badge/-YouTube-black.svg?style=for-the-badge&logo=youtube&colorB=red" alt="Logo">
7373
</a>
7474
</p>
@@ -164,18 +164,21 @@ Visualize the result.
164164

165165
![results](./gallery/gifl_fastdup_quickstart_V1_optimized.gif)
166166

167-
Here are 8 lines of code you'll need in most cases.
167+
In short, you'll need 3 lines of code to run fastdup:
168168

169169
```python
170170
import fastdup
171-
172-
fd = fastdup.create(work_dir, images_dir)
171+
fd = fastdup.create("IMAGE_FOLDER/")
173172
fd.run()
173+
```
174+
175+
And 5 lines of code to visualize issues:
174176

175-
fd.vis.duplicates_gallery() # create a visual gallery of found duplicates
177+
```python
178+
fd.vis.duplicates_gallery() # create a visual gallery of duplicates
176179
fd.vis.outliers_gallery() # create a visual gallery of anomalies
177180
fd.vis.component_gallery() # create a visualization of connected components
178-
fd.vis.stats_gallery() # create a visualization of images statistics (for example blur)
181+
fd.vis.stats_gallery() # create a visualization of images statistics (e.g. blur)
179182
fd.vis.similarity_gallery() # create a gallery of similar images
180183
```
181184

@@ -641,9 +644,11 @@ The following are community-contributed blog posts about fastdup -
641644
![feedback](./gallery/user_quotes.png)
642645

643646
## License
644-
fastdup is licensed under Creative Commons 4.0 license.
647+
fastdup is licensed under [Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International](https://creativecommons.org/licenses/by-nc-nd/4.0/) Public License.
648+
645649
See [LICENSE](./LICENSE).
646650

651+
647652
For any queries, reach us at [email protected]
648653

649654
## Disclaimer

0 commit comments

Comments
 (0)