swap.utils.control

class swap.utils.control.SWAP(config)

Bases: object

__init__(config)

Initialize self. See help(type(self)) for accurate signature.

apply_gold(subject, gold)

apply_golds(golds)

apply_subjects()

classify(user, subject, cl, id_)

classmethod load(name)

performance

retire()

save()

score_subjects()

score_users()

truncate()

swap.utils.config

class swap.utils.config.Config(name, **kwargs)

Bases: object

__init__(name, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

dump()

classmethod load(data)

swap.utils.collection

class swap.utils.collection.Collection(config, items=None)

Bases: object

__init__(config, items=None)

Initialize self. See help(type(self)) for accurate signature.

add(item)

dump()

iter()

keys()

list()

load(data)

static new(item)

subset(items)

truncate()

swap.utils.online

class swap.utils.online.Online

Bases: object

static receive(swap)

static send(swap)

swap.utils.parser

class swap.utils.parser.ClassificationParser(config)

Bases: object

__init__(config)

Initialize self. See help(type(self)) for accurate signature.

parse(cl)

class swap.utils.parser.AnnotationParser(config)

Bases: object

__init__(config)

Initialize self. See help(type(self)) for accurate signature.

parse(annotations)

swap.utils.subject

class swap.utils.subject.Subject(subject, gold, config, score=None, seen=0, retired=None)

Bases: object

Class to track an individual subject, its gold status, and its score.

__init__(subject, gold, config, score=None, seen=0, retired=None)

Initialize self. See help(type(self)) for accurate signature.

classify(user, cl)

Add a classification to this subject

user: user that made the classification cl: classification, 1 or 0

dump()

Dump this subject

classmethod load(data)

Load a subject from dumped data

classmethod new(subject, gold, config)

Create a new Subject

score

truncate()

Clear the history of this subject, and update the prior to the current score.

update_score(thresholds=None, history=False)

Recalculate the score for this subject from its stored classification history.

thresholds: Also update retirement status of this subject given

threshold parameters. (bogus, real)

history: (bool) Return list of score history

update_user(user)

Update the history of this subject when a user’s score has changed

class swap.utils.subject.Subjects(config, items=None)

Bases: swap.utils.collection.Collection

Collection of Subjects

get_changed()

gold()

Return subjects that have a gold label

new(subject)

Create and return a new Subject

retired()

Return all retired subjects

class swap.utils.subject.Thresholds(subjects, fpr, mdr, thresholds=None)

Bases: object

Class to determine retirement thresholds

Thresholds are determined from the false positive rate (fpr) and the missed detection rate (mdr), considering only the subjects with gold labels. The bogus retirement threshold is set such that a rate equal to mdr of real subjects are mislabeled as bogus. The real retirement threshold is set such that a rate equal to fpr of bogus subjects are labeled as real.

__init__(subjects, fpr, mdr, thresholds=None)

Initialize self. See help(type(self)) for accurate signature.

dump()

Dump thresholds object

get_counts(scores)

Get number of subjects in each gold label class (-1,0,1)

get_scores()

Generate sorted list of subject scores and gold labels

classmethod load(subjects, data)

Load thresholds from dumped data

swap.utils.user

class swap.utils.user.User(user, username, confusion, config)

Bases: object

__init__(user, username, confusion, config)

Parameters:confusion (([0_numer, 1_numer], [0_denom, 1_denom])) –

classify(subject, cl)

confusion

dump()

classmethod load(data)

classmethod new(user, username, config)

save()

score

truncate()

update_score()

update_subject(subject)

class swap.utils.user.Users(config, items=None)

Bases: swap.utils.collection.Collection

new(user)

caesar_external.extractor

Get classifications from Panoptes

class caesar_external.extractor.Extractor

Bases: object

classmethod get_classifications(last_id)

classmethod last_id(next_id=None)

classmethod next()

caesar_external.reducer

Get classifications from Panoptes

caesar_external.data

Storage module to track which classification was gotten last

class caesar_external.data.Config(name, project, workflow, last_id, **kwargs)

Bases: object

__init__(name, project, workflow, last_id, **kwargs)

Initialize self. See help(type(self)) for accurate signature.

static caesar_endpoint()

dump()

classmethod instance()

classmethod load(name)

save()

workflow_path()

caesar_external.utils.caesar_utils

class caesar_external.utils.caesar_utils.Client

Bases: object

__init__()

Initialize self. See help(type(self)) for accurate signature.

classmethod extract(project, last_id)

classmethod instance()

classmethod reduce(subject, data)

PUT subject score to Caesar