mozilla / webcompat-ml-docs

Documentation about ML in webcompat
11 stars 0 forks source link

Documentation for models is dry #4

Open karlcow opened 4 years ago

karlcow commented 4 years ago

@johngian not really an issue but trying to understand things here.

Would it be possible to describe a bit more this section https://webcompat-ml.readthedocs.io/en/latest/models.html#report

Edited: Replaced with comments on https://github.com/mozilla/webcompat-ml/commit/5c78f24578e5aacd02e6b66966fa0f27dff4d571#diff-85a14de82210f04c130c55f12fcde626

karlcow commented 4 years ago

Replaced with comments on https://github.com/mozilla/webcompat-ml/commit/5c78f24578e5aacd02e6b66966fa0f27dff4d571#diff-85a14de82210f04c130c55f12fcde626

karlcow commented 4 years ago

The meat of the Machine Learning code seems to be in https://github.com/mozilla/webcompat-ml/blob/b3922d4ed57e7cccf7cb93a4df7df23bd7b16575/src/webcompat_ml/models/needsdiagnosis/model.py

class NeedsDiagnosisModel(BaseEstimator, TransformerMixin, ClassifierMixin):

This will be the big piece to analyze and understand.

karlcow commented 4 years ago

I found another way to comment the code which will be probably better for now. Demo here. https://imgur.com/a/QdCFgHN