Missing Documentation about c3

[lazyoracle]

Current missing documentation, obtained using $ docstr-coverage -i -m --verbose=2 c3/

File: "/home/users/anurag/dev/c3/c3/__init__.py"
 Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%


File: "/home/users/anurag/dev/c3/c3/c3objs.py"
 Needed: 19; Found: 10; Missing: 9; Coverage: 52.6%


File: "/home/users/anurag/dev/c3/c3/experiment.py"
 Needed: 24; Found: 23; Missing: 1; Coverage: 95.8%


File: "/home/users/anurag/dev/c3/c3/generator/devices.py"
 Needed: 66; Found: 46; Missing: 20; Coverage: 69.7%


File: "/home/users/anurag/dev/c3/c3/generator/generator.py"
 Needed: 8; Found: 6; Missing: 2; Coverage: 75.0%


File: "/home/users/anurag/dev/c3/c3/libraries/algorithms.py"
 Needed: 18; Found: 15; Missing: 3; Coverage: 83.3%


File: "/home/users/anurag/dev/c3/c3/libraries/chip.py"
 Needed: 61; Found: 26; Missing: 35; Coverage: 42.6%


File: "/home/users/anurag/dev/c3/c3/libraries/envelopes.py"
 Needed: 29; Found: 28; Missing: 1; Coverage: 96.6%


File: "/home/users/anurag/dev/c3/c3/libraries/estimators.py"
 Needed: 20; Found: 17; Missing: 3; Coverage: 85.0%


File: "/home/users/anurag/dev/c3/c3/libraries/fidelities.py"
 Needed: 30; Found: 17; Missing: 13; Coverage: 56.7%


File: "/home/users/anurag/dev/c3/c3/libraries/propagation.py"
 Needed: 10; Found: 8; Missing: 2; Coverage: 80.0%


File: "/home/users/anurag/dev/c3/c3/libraries/tasks.py"
 Needed: 9; Found: 8; Missing: 1; Coverage: 88.9%


File: "/home/users/anurag/dev/c3/c3/model.py"
 Needed: 32; Found: 20; Missing: 12; Coverage: 62.5%


File: "/home/users/anurag/dev/c3/c3/optimizers/modellearning.py"
 Needed: 11; Found: 9; Missing: 2; Coverage: 81.8%


File: "/home/users/anurag/dev/c3/c3/optimizers/optimalcontrol.py"
 Needed: 8; Found: 5; Missing: 3; Coverage: 62.5%


File: "/home/users/anurag/dev/c3/c3/optimizers/optimalcontrol_robust.py"
 Needed: 4; Found: 2; Missing: 2; Coverage: 50.0%


File: "/home/users/anurag/dev/c3/c3/optimizers/optimizer.py"
 Needed: 25; Found: 13; Missing: 12; Coverage: 52.0%


File: "/home/users/anurag/dev/c3/c3/parametermap.py"
 Needed: 26; Found: 20; Missing: 6; Coverage: 76.9%


File: "/home/users/anurag/dev/c3/c3/qiskit/__init__.py"
 Needed: 1; Found: 0; Missing: 1; Coverage: 0.0%


File: "/home/users/anurag/dev/c3/c3/qiskit/c3_backend.py"
 Needed: 19; Found: 14; Missing: 5; Coverage: 73.7%


File: "/home/users/anurag/dev/c3/c3/qiskit/c3_job.py"
 Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%


File: "/home/users/anurag/dev/c3/c3/qiskit/c3_provider.py"
 Needed: 5; Found: 4; Missing: 1; Coverage: 80.0%


File: "/home/users/anurag/dev/c3/c3/signal/gates.py"
 Needed: 14; Found: 3; Missing: 11; Coverage: 21.4%


File: "/home/users/anurag/dev/c3/c3/signal/pulse.py"
 Needed: 10; Found: 8; Missing: 2; Coverage: 80.0%


File: "/home/users/anurag/dev/c3/c3/utils/log_reader.py"
 Needed: 2; Found: 1; Missing: 1; Coverage: 50.0%


File: "/home/users/anurag/dev/c3/c3/utils/tf_utils.py"
 Needed: 36; Found: 34; Missing: 2; Coverage: 94.4%


File: "/home/users/anurag/dev/c3/c3/utils/utils.py"
 Needed: 10; Found: 8; Missing: 2; Coverage: 80.0%


Overall statistics for 41 files (5 files are empty) (skipped all non-init magic methods) (skipped __init__ methods):
Needed: 564  -  Found: 410  -  Missing: 154
Total coverage: 72.7%  -  Grade: Very good