Skip to content
This repository has been archived by the owner on Dec 13, 2024. It is now read-only.

Commit

Permalink
DOC: update TODO and README
Browse files Browse the repository at this point in the history
Correct some paths in README. In TODO, mention incremental fingerprint
database update.
  • Loading branch information
elcorto committed May 27, 2018
1 parent c5d33c8 commit fe9b8a2
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,14 @@ Example session:
>>> from imagecluster import main
>>> main.main('/path/to/testpics/', sim=0.5)
no fingerprints database /path/to/testpics/fingerprints.pk found
no fingerprints database /path/to/testpics/imagecluster/fingerprints.pk found
running all images through NN model ...
/path/to/testpics/DSC_1061.JPG
/path/to/testpics/DSC_1080.JPG
...
/path/to/testpics/DSC_1087.JPG
clustering ...
cluster dir: /path/to/testpics/clusters
cluster dir: /path/to/testpics/imagecluster/clusters
cluster size : ncluster
2 : 7
3 : 2
Expand All @@ -57,8 +57,8 @@ Have a look at the clusters (as dirs with symlinks to the relevant files):

.. code:: sh
$ tree /path/to/testpics
/path/to/testpics/clusters
$ tree /path/to/testpics/imagecluster/clusters
/path/to/testpics/imagecluster/clusters
├── cluster_with_10
│   └── cluster_0
│   ├── DSC_1068.JPG -> /path/to/testpics/DSC_1068.JPG
Expand Down
7 changes: 7 additions & 0 deletions TODO
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,10 @@
* Split imagecluster.make_links() into grouping clusters of same size (e.g.
group_clusters() and link creation (make_links()). Add test for
group_clusters().

* When calculating fingerprints: If fingerprints.pk is present, check for new
image files and calculate for those only.

* Add option to main() for passing a global fingerprints.pk file, which gets
updated. Remove hard-coded location
/path/to/pics/imagecluster/fingerprints.pk

0 comments on commit fe9b8a2

Please sign in to comment.