dpgen2.exploration.report package

Submodules

dpgen2.exploration.report.naive_report module

class dpgen2.exploration.report.naive_report.NaiveExplorationReport(counter_f, counter_v)

Bases: ExplorationReport

Methods

accurate_ratio
calculate_ratio
candidate_ratio
failed_ratio
ratio

accurate_ratio(tag=None) → float

static calculate_ratio(cc, ca, cf)

candidate_ratio(tag=None) → float

failed_ratio(tag=None) → float

ratio(quantity: str, item: str) → float

dpgen2.exploration.report.report module

class dpgen2.exploration.report.report.ExplorationReport

Bases: ABC

Methods

accurate_ratio
candidate_ratio
failed_ratio

abstract accurate_ratio(tag=None) → float

abstract candidate_ratio(tag=None) → float

abstract failed_ratio(tag=None) → float

dpgen2.exploration.report.trajs_report module

class dpgen2.exploration.report.trajs_report.TrajsExplorationReport

Bases: ExplorationReport

Methods

get_candidates([max_nframes])	Get candidates.
record_traj(id_f_accu, id_f_cand, id_f_fail, ...)	Record one trajctory.

accurate_ratio
candidate_ratio
clear
failed_ratio

accurate_ratio(tag=None)

candidate_ratio(tag=None)

clear()

failed_ratio(tag=None)

get_candidates(max_nframes: Optional[int] = None) → List[Tuple[int, int]]

Get candidates. If number of candidates is larger than max_nframes, then randomly pick max_nframes frames from the candidates.

Parameters

max_nframes int

The maximal number of frames of candidates.

Returns

cand_frames List[Tuple[int,int]]

Candidate frames. A list of tuples: [(traj_idx, frame_idx), …]

record_traj(id_f_accu, id_f_cand, id_f_fail, id_v_accu, id_v_cand, id_v_fail)

Record one trajctory. inputs are the indexes of candidate, accurate and failed frames.