Inappropriate documentation and inconsistencies in the LFW database
Created by: siebenkopf
The documentation of the functions inside the In the bob.db.lfw.Database are incomplete/misleading:
- What is the difference between "clients", "clients_ids" and "clients_names"? Is the "clients_names" information really important for out purpose?
- The documentation of the "protocol" and "groups" parameters is misleading. If there are no groups and no protocols defined, either remove these keywords or document that these parameters are ignored.
- The documentation of the "files" method is incorrect since the method only returns the file names.
Furthermore, there are inconsistencies with other databases:
- To be consistent with other databases, the "clients" function should return the list of client ids, but it returns a list of tuples (client_id, client_name).
Additionally, I don't find a way to use the "unrestricted" training configuration that might be useful to train our algorithms. Is it possible to retrieve the required data for that?