Scikit-learn: 모든 속성이 문서화되었는지 확인

에 만든 2019년 07월 12일 · 79코멘트 · 출처: scikit-learn/scikit-learn

# 13385에 설명 된대로 모든 속성이 문서화되었는지 확인해야합니다.

이 작업을하려면 특정 하위 모듈을 선택하고 해당 하위 모듈의 모든 속성 문서 불일치를 수정해야합니다.

다음은 나머지 항목을 찾는 스크립트입니다 (잘못된 긍정이있을 수 있음).

import numpy as np
from sklearn.base import clone
from sklearn.utils.testing import all_estimators
from sklearn.utils.estimator_checks import pairwise_estimator_convert_X, enforce_estimator_tags_y
from numpydoc import docscrape

ests = all_estimators()

for name, Est in ests:
    try:
        estimator_orig = Est()
    except:
        continue
    rng = np.random.RandomState(0)
    X = pairwise_estimator_convert_X(rng.rand(40, 10), estimator_orig)
    X = X.astype(object)
    y = (X[:, 0] * 4).astype(np.int)
    est = clone(estimator_orig)
    y = enforce_estimator_tags_y(est, y)
    try:
        est.fit(X, y)
    except:
        continue
    fitted_attrs = [(x, getattr(est, x, None))
                    for x in est.__dict__.keys() if x.endswith("_")
                    and not x.startswith("_")]
    doc = docscrape.ClassDoc(type(est))
    doc_attributes = []
    incorrect = []
    for att_name, type_definition, param_doc in doc['Attributes']:
        if not type_definition.strip():
            if ':' in att_name and att_name[:att_name.index(':')][-1:].strip():
                incorrect += [name +
                              ' There was no space between the param name and '
                              'colon (%r)' % att_name]
            elif name.rstrip().endswith(':'):
                incorrect += [name +
                              ' Parameter %r has an empty type spec. '
                              'Remove the colon' % (att_name.lstrip())]

        if '*' not in att_name:
            doc_attributes.append(att_name.split(':')[0].strip('` '))
    assert incorrect == []
    fitted_attrs_names = [x[0] for x in fitted_attrs]

    bad = sorted(list(set(fitted_attrs_names) ^ set(doc_attributes)))
    if len(bad) > 0:
        msg = '{}\n'.format(name) + '\n'.join(bad)
        print("Docstring Error: Attribute mismatch in " + msg)

Documentation Easy good first issue help wanted

출처

amueller

🚀1 👍1

가장 유용한 댓글

각 추정기에 대한 속성 독 스트링 누락

PR에서이 문제를 참조하세요.

[x] ARDRegression, [절편 _]
[x] AdaBoostClassifier, [base_estimator_]
[x] AdaBoostRegressor, [base_estimator_]
[x] AdditiveChi2Sampler, [sample_interval_]
[x] AgglomerativeClustering, [n_components _] (더 이상 사용되지 않음)
[x] BaggingClassifier, [n_features_]
[x] BaggingRegressor, [base_estimator_, n_features_]
[x] BayesianGaussianMixture, [mean_precision_prior, mean_precision_prior_]
[x] BayesianRidge, [X_offset_, X_scale_]
[x] BernoulliNB, [coef_, intercept_]
[x] BernoulliRBM, [h_samples_]
[] 자작 나무, [fit_, partial_fit_]
[] CCA, [coef_, x_mean_, x_std_, y_mean_, y_std_]
[x] CheckingClassifier, [classes_]
[x] ComplementNB, [coef_, intercept_]
[x] CountVectorizer, [stop_words_, vocabulary_]
[] DecisionTreeRegressor, [classes_, n_classes_]
[x] DictVectorizer, [feature_names_, vocabulary_]
[] DummyClassifier, [output_2d_]
[] DummyRegressor, [output_2d_]
[] ElasticNet, [dual_gap_]
[] ElasticNetCV, [dual_gap_]
[] EllipticEnvelope, [dist_, raw_covariance_, raw_location_, raw_support_]
[x] ExtraTreeClassifier, [feature_importances_]
[] ExtraTreeRegressor, [classes_, feature_importances_, n_classes_]
[x] ExtraTreesClassifier, [base_estimator_]
[x] ExtraTreesRegressor, [base_estimator_]
[x] FactorAnalysis, [mean_]
[] FeatureAgglomeration, [n_components_]
[x] GaussianProcessClassifier, [base_estimator_]
[x] GaussianRandomProjection, [구성 요소 _]
[x] GradientBoostingClassifier, [max_features_, n_classes_, n_features_, oob_improvement_]
[x] GradientBoostingRegressor, [max_features_, n_classes_, n_estimators_, n_features_, oob_improvement_]
[x] HistGradientBoostingClassifier, [bin_mapper_, classes_, do_early_stopping_, loss_, n_features_, scorer_]
[x] HistGradientBoostingRegressor, [bin_mapper_, do_early_stopping_, loss_, n_features_, scorer_]
[x] IncrementalPCA, [batch_size_]
[x] IsolationForest, [base_estimator_, estimators_features_, n_features_]
[x] IsotonicRegression, [X_max_, X_min_, f_]
[x] IterativeImputer, [random_state_]
[x] KNeighborsClassifier, [classes_, effective_metric_, effective_metric_params_, outputs_2d_]
[x] KNeighborsRegressor, [유효 _ 메트릭 _, 유효 _ 메트릭 _params_]
[x] KernelCenterer, [K_fit_all_, K_fit_rows_]
[x] KernelDensity, [tree_]
[x] KernelPCA, [X_transformed_fit_, dual_coef_]
[x] LabelBinarizer, [classes_, sparse_input_, y_type_]
[x] LabelEncoder, [클래스 _]
[x] LarsCV, [활성 _]
[x] 올가미, [dual_gap_]
[x] LassoLarsCV, [활성 _]
[x] LassoLarsIC, [alphas_]
[x] LatentDirichletAllocation, [bound_, doc_topic_prior_, exp_dirichlet_component_, random_state_, topic_word_prior_]
[x] LinearDiscriminantAnalysis, [공분산 _]
[x] 선형 회귀, [순위 _, 특이 _]
[x] LinearSVC, [클래스 _]
[x] LocalOutlierFactor, [effective_metric_, effective_metric_params_]
[x] MDS, [dissimilarity_matrix_, n_iter_]
[x] MLPClassifier, [best_loss_, loss_curve_, t_]
[x] MLPRegressor, [best_loss_, loss_curve_, t_]
[x] MinMaxScaler, [n_samples_seen_]
[x] MiniBatchDictionaryLearning, [iter_offset_]
[x] MiniBatchKMeans, [counts_, init_size_, n_iter_]
[x] MultiLabelBinarizer, [classes_]
[x] MultiTaskElasticNet, [dual_gap_, eps_, sparse_coef_]
[x] MultiTaskElasticNetCV, [dual_gap_]
[x] MultiTaskLasso, [dual_gap_, eps_, sparse_coef_]
[x] MultiTaskLassoCV, [dual_gap_]
[x] NearestCentroid, [classes_]
[x] NearestNeighbors, [effective_metric_, effective_metric_params_]
[x] NeighborhoodComponentsAnalysis, [random_state_]
[x] NuSVC, [class_weight_, fit_status_, probA_, probB_, shape_fit_]
[] NuSVR, [class_weight_, fit_status_, n_support_, probA_, probB_, shape_fit_]
[x] OAS, [location_]
[] OneClassSVM, [class_weight_, fit_status_, n_support_, probA_, probB_, shape_fit_]
[x] OneVsOneClassifier, [n_classes_]
[x] OneVsRestClassifier, [coef_, intercept_, n_classes_]
[x] OrthogonalMatchingPursuit, [n_nonzero_coefs_]
[] PLSCanonical, [coef_, x_mean_, x_std_, y_mean_, y_std_]
[x] PLSRegression, [x_mean_, x_std_, y_mean_, y_std_]
[] PLSSVD, [x_mean_, x_std_, y_mean_, y_std_]
[x] PassiveAggressiveClassifier, [loss_function_, t_]
[x] PassiveAggressiveRegressor, [t_]
[x] 퍼셉트론, [loss_function_]
[x] QuadraticDiscriminantAnalysis, [classes_, covariance_]
[x] RBFSampler, [random_offset_, random_weights_]
[] RFE, [classes_]
[] RFECV, [클래스 _]
[x] RadiusNeighborsClassifier, [classes_, effective_metric_, effective_metric_params_, outputs_2d_]
[x] RadiusNeighborsRegressor, [effective_metric_, effective_metric_params_]
[x] RandomForestClassifier, [oob_decision_function_, oob_score_]
[x] RandomForestRegressor, [oob_prediction_, oob_score_]
[x] RandomTreesEmbedding, [base_estimator_, feature_importances_, n_features_, n_outputs_, one_hot_encoder_]
[x] RidgeCV, [cv_values_]
[x] RidgeClassifier, [classes_]
[x] RidgeClassifierCV, [cv_values_]
[x] SGDClassifier, [classes_, t_]
[x] SGDRegressor, [average_coef_, average_intercept_]
[x] SVC, [class_weight_, shape_fit_]
[] SVR, [class_weight_, fit_status_, n_support_, probA_, probB_, shape_fit_]
[x] SelectKBest, [pvalues_, scores_]
[x] ShrunkCovariance, [수축]
[x] SkewedChi2Sampler, [random_offset_, random_weights_]
[x] SparseRandomProjection, [구성 요소 _, 밀도 _]
[x] SpectralEmbedding, [n_neighbors_]
[x] TfidfVectorizer, [stop_words_, vocabulary_]

thomasjpfan 에 2019년 07월 13일

👍6

모든 79 댓글

NMF 클래스 설명의 속성 문서에서 이미 하나 이상의 불일치를 발견했습니다. 이 일을 좀 할 수있을 것 같아요. decomposition 및 random_projection 하위 모듈 내에서 몇 가지 변경 사항을 제안 할 준비가 거의되었습니다.

alexitkes 에 2019년 07월 12일

각 추정기에 대한 속성 독 스트링 누락

PR에서이 문제를 참조하세요.

[x] ARDRegression, [절편 _]
[x] AdaBoostClassifier, [base_estimator_]
[x] AdaBoostRegressor, [base_estimator_]
[x] AdditiveChi2Sampler, [sample_interval_]
[x] AgglomerativeClustering, [n_components _] (더 이상 사용되지 않음)
[x] BaggingClassifier, [n_features_]
[x] BaggingRegressor, [base_estimator_, n_features_]
[x] BayesianGaussianMixture, [mean_precision_prior, mean_precision_prior_]
[x] BayesianRidge, [X_offset_, X_scale_]
[x] BernoulliNB, [coef_, intercept_]
[x] BernoulliRBM, [h_samples_]
[] 자작 나무, [fit_, partial_fit_]
[] CCA, [coef_, x_mean_, x_std_, y_mean_, y_std_]
[x] CheckingClassifier, [classes_]
[x] ComplementNB, [coef_, intercept_]
[x] CountVectorizer, [stop_words_, vocabulary_]
[] DecisionTreeRegressor, [classes_, n_classes_]
[x] DictVectorizer, [feature_names_, vocabulary_]
[] DummyClassifier, [output_2d_]
[] DummyRegressor, [output_2d_]
[] ElasticNet, [dual_gap_]
[] ElasticNetCV, [dual_gap_]
[] EllipticEnvelope, [dist_, raw_covariance_, raw_location_, raw_support_]
[x] ExtraTreeClassifier, [feature_importances_]
[] ExtraTreeRegressor, [classes_, feature_importances_, n_classes_]
[x] ExtraTreesClassifier, [base_estimator_]
[x] ExtraTreesRegressor, [base_estimator_]
[x] FactorAnalysis, [mean_]
[] FeatureAgglomeration, [n_components_]
[x] GaussianProcessClassifier, [base_estimator_]
[x] GaussianRandomProjection, [구성 요소 _]
[x] GradientBoostingClassifier, [max_features_, n_classes_, n_features_, oob_improvement_]
[x] GradientBoostingRegressor, [max_features_, n_classes_, n_estimators_, n_features_, oob_improvement_]
[x] HistGradientBoostingClassifier, [bin_mapper_, classes_, do_early_stopping_, loss_, n_features_, scorer_]
[x] HistGradientBoostingRegressor, [bin_mapper_, do_early_stopping_, loss_, n_features_, scorer_]
[x] IncrementalPCA, [batch_size_]
[x] IsolationForest, [base_estimator_, estimators_features_, n_features_]
[x] IsotonicRegression, [X_max_, X_min_, f_]
[x] IterativeImputer, [random_state_]
[x] KNeighborsClassifier, [classes_, effective_metric_, effective_metric_params_, outputs_2d_]
[x] KNeighborsRegressor, [유효 _ 메트릭 _, 유효 _ 메트릭 _params_]
[x] KernelCenterer, [K_fit_all_, K_fit_rows_]
[x] KernelDensity, [tree_]
[x] KernelPCA, [X_transformed_fit_, dual_coef_]
[x] LabelBinarizer, [classes_, sparse_input_, y_type_]
[x] LabelEncoder, [클래스 _]
[x] LarsCV, [활성 _]
[x] 올가미, [dual_gap_]
[x] LassoLarsCV, [활성 _]
[x] LassoLarsIC, [alphas_]
[x] LatentDirichletAllocation, [bound_, doc_topic_prior_, exp_dirichlet_component_, random_state_, topic_word_prior_]
[x] LinearDiscriminantAnalysis, [공분산 _]
[x] 선형 회귀, [순위 _, 특이 _]
[x] LinearSVC, [클래스 _]
[x] LocalOutlierFactor, [effective_metric_, effective_metric_params_]
[x] MDS, [dissimilarity_matrix_, n_iter_]
[x] MLPClassifier, [best_loss_, loss_curve_, t_]
[x] MLPRegressor, [best_loss_, loss_curve_, t_]
[x] MinMaxScaler, [n_samples_seen_]
[x] MiniBatchDictionaryLearning, [iter_offset_]
[x] MiniBatchKMeans, [counts_, init_size_, n_iter_]
[x] MultiLabelBinarizer, [classes_]
[x] MultiTaskElasticNet, [dual_gap_, eps_, sparse_coef_]
[x] MultiTaskElasticNetCV, [dual_gap_]
[x] MultiTaskLasso, [dual_gap_, eps_, sparse_coef_]
[x] MultiTaskLassoCV, [dual_gap_]
[x] NearestCentroid, [classes_]
[x] NearestNeighbors, [effective_metric_, effective_metric_params_]
[x] NeighborhoodComponentsAnalysis, [random_state_]
[x] NuSVC, [class_weight_, fit_status_, probA_, probB_, shape_fit_]
[] NuSVR, [class_weight_, fit_status_, n_support_, probA_, probB_, shape_fit_]
[x] OAS, [location_]
[] OneClassSVM, [class_weight_, fit_status_, n_support_, probA_, probB_, shape_fit_]
[x] OneVsOneClassifier, [n_classes_]
[x] OneVsRestClassifier, [coef_, intercept_, n_classes_]
[x] OrthogonalMatchingPursuit, [n_nonzero_coefs_]
[] PLSCanonical, [coef_, x_mean_, x_std_, y_mean_, y_std_]
[x] PLSRegression, [x_mean_, x_std_, y_mean_, y_std_]
[] PLSSVD, [x_mean_, x_std_, y_mean_, y_std_]
[x] PassiveAggressiveClassifier, [loss_function_, t_]
[x] PassiveAggressiveRegressor, [t_]
[x] 퍼셉트론, [loss_function_]
[x] QuadraticDiscriminantAnalysis, [classes_, covariance_]
[x] RBFSampler, [random_offset_, random_weights_]
[] RFE, [classes_]
[] RFECV, [클래스 _]
[x] RadiusNeighborsClassifier, [classes_, effective_metric_, effective_metric_params_, outputs_2d_]
[x] RadiusNeighborsRegressor, [effective_metric_, effective_metric_params_]
[x] RandomForestClassifier, [oob_decision_function_, oob_score_]
[x] RandomForestRegressor, [oob_prediction_, oob_score_]
[x] RandomTreesEmbedding, [base_estimator_, feature_importances_, n_features_, n_outputs_, one_hot_encoder_]
[x] RidgeCV, [cv_values_]
[x] RidgeClassifier, [classes_]
[x] RidgeClassifierCV, [cv_values_]
[x] SGDClassifier, [classes_, t_]
[x] SGDRegressor, [average_coef_, average_intercept_]
[x] SVC, [class_weight_, shape_fit_]
[] SVR, [class_weight_, fit_status_, n_support_, probA_, probB_, shape_fit_]
[x] SelectKBest, [pvalues_, scores_]
[x] ShrunkCovariance, [수축]
[x] SkewedChi2Sampler, [random_offset_, random_weights_]
[x] SparseRandomProjection, [구성 요소 _, 밀도 _]
[x] SpectralEmbedding, [n_neighbors_]
[x] TfidfVectorizer, [stop_words_, vocabulary_]

thomasjpfan 에 2019년 07월 13일

👍6

다음을 포함하는 tree 하위 모듈 속성 문서 불일치 문제를 해결할 수 있습니다.

DecisionTreeRegressor, [classes_, n_classes_]
ExtraTreeClassifier, [classes_, max_features_, n_classes_, n_features_, n_outputs_, tree_]
ExtraTreeRegressor, [classes_, max_features_, n_classes_, n_features_, n_outputs_, tree_]

mepa 에 2019년 07월 13일

저는 LinearRegression, [rank_, singular_] 작업 중입니다.

wendyhhu 에 2019년 07월 13일

👍1

LinearSVC, [n_iter_] 및 LinearSVR, [n_iter_] 작업 중입니다.

wendyhhu 에 2019년 07월 13일

👍1

나는 Gradient boosting ie

GradientBoostingClassifier [base_estimator_, max_features_, n_classes_, n_features_]
- GradientBoostingRegressor [base_estimator_, classes_, max_features_, n_estimators_, n_features_]

matsmaiwald 에 2019년 07월 14일

신경 쓰지 마세요, 속성이 누락 된 부분과 그렇지 않은 부분을 잘못 읽음

matsmaiwald 에 2019년 07월 14일

naive_bayes 하위 모듈의 분류 자에 대해 문서화되지 않은 classes_ 속성도있는 것 같습니다. 나는 그것을 고치기 시작했습니다.

alexitkes 에 2019년 07월 14일

TfidfVectorizer, [fixed_vocabulary_] 작업 할 것입니다.

mandalbiswadip 에 2019년 07월 14일

나는 일할 것이다 :

RandomForestClassifier, [base_estimator_]
RandomForestRegressor, [base_estimator_, n_classes_]
ExtraTreesClassifier, [base_estimator_]
ExtraTreesRegressor, [base_estimator_, n_classes_]

rcwoolston 에 2019년 07월 14일

나는 일하고있다 :

SGDClassifier, [average_coef_, average_intercept_, standard_coef_, standard_intercept_]
SGDRegressor, [standard_coef_, standard_intercept_]

편집 : 이러한 속성을 공개에서 비공개로 변경하는 문제를 열었습니다 (참조 : # 14364).

wendyhhu 에 2019년 07월 14일

나는 일하고있다 :
KernelCenterer, [K_fit_all_, K_fit_rows_]
MinMaxScaler, [n_samples_seen_]

SwordKnight6216 에 2019년 07월 14일

나는 일할 것이다 :

RandomTreesEmbedding, [base_estimator_, classes_, feature_importances_, n_classes_, n_features_, n_outputs_, one_hot_encoder_]

rcwoolston 에 2019년 07월 14일

또한 KNeighborsClassifier , KNeighborsRegressor 및 neighbors 모듈의 다른 클래스에 속성 문서가 전혀 없음을 발견했습니다. 현재 2 개의 속성이있는 KNeighborsRegressor 중 :

effective_metric_
effective_metric_params_

KNeighborsClassifier 클래스에는 네 가지 속성이 있습니다.

classes_
effective_metric_
effective_metric_params_
outputs_2d_

alexitkes 에 2019년 07월 14일

@alexitkes 좋은 캐치. 감사!

amueller 에 2019년 07월 14일

QuadraticDiscriminantAnalysis 작업, [classes_, covariance_]

abhishek-jana 에 2019년 07월 15일

KNeighborsClassifier 작업, [classes_, effective_metric_, effective_metric_params_, outputs_2d_]
RadiusNeighborsClassifier, [classes_, effective_metric_, effective_metric_params_, outputs_2d_]

abhishek-jana 에 2019년 07월 15일

작업:
LinearSVC, [클래스 _]
NuSVC, [class_weight_, classes_, fit_status_, probA_, probB_, shape_fit_]
SVC, [class_weight_, classes_, shape_fit_]

kwinata 에 2019년 07월 20일

작업:

[] BaggingClassifier, [n_features_, oob_decision_function_, oob_score_]
[] BaggingRegressor, [base_estimator_, n_features_, oob_prediction_, oob_score_]
[] AdaBoostClassifier, [base_estimator_]
[] AdaBoostRegressor, [base_estimator_]

mdomarsaleem 에 2019년 07월 25일

작업:

CountVectorizer, [stop_words_, vocabulary_]
DictVectorizer, [feature_names_, vocabulary_]

pvsagar 에 2019년 07월 25일

안녕 !! 이 문제를 도와 드리고 싶습니다. 누구든지 어디서부터 시작해야하는지 말해 줄 수 있나요 ??

ManishAradwad 에 2019년 08월 05일

dict_learning.py @spbail 의 함수를 작업 중입니다.

hannahbrucemacdonald 에 2019년 08월 24일

@ olgadk7을 사용하여 LinearDiscriminantAnalysis 작업

m-clare 에 2019년 08월 24일

RidgeClassifierCV @ npatta01의 속성 불일치 작업

ingrid88 에 2019년 08월 24일

@ ingrid88 + @ npatta01로 DecisionTreeRegressor 작업

meiguan 에 2019년 08월 24일

@ olgadk7을 사용하여 LinearDiscriminantAnalysis 작업

위의 속성 스크립트에 대해 오 탐지. 이것은 문서화되었습니다.

m-clare 에 2019년 08월 24일

@ olgadk7로 AdditiveChi2Sampler 작업

m-clare 에 2019년 08월 24일

@eugeniaft로 LabelEncoder 작업

FranciDona 에 2019년 08월 24일

randomtreeclassifier에서 작업을 시도합니다!

joyharjanto 에 2019년 08월 24일

작업

퍼셉트론

joanaz 에 2019년 08월 24일

BernoulliRBM 작업

npatta01 에 2019년 08월 24일

ExtraTreeClassifer 작업

she-dares 에 2019년 08월 24일

@eugeniaft로 LabelEncoder 작업

LabelEncoder는 불일치가없는 것 같습니다. OneClassSVM에서 작업 중입니다.

FranciDona 에 2019년 08월 24일

트리 회귀자는 대신 클래스를 폐기해야한다고 생각합니다.

amueller 에 2019년 08월 24일

SVR 작업

ingrid88 에 2019년 08월 24일

작업:

OneVsOneClassifier, [n_classes_]
OneVsRestClassifier, [coef_, intercept_, n_classes_]

YuliaZamriy 에 2019년 08월 24일

LinearRegression, [rank_, singular_] 작업

arzoobh 에 2019년 08월 24일

LatentDirichletAllocation 작업, [bound_, doc_topic_prior_, exp_dirichlet_component_, random_state_, topic_word_prior_]

YuliaZamriy 에 2019년 08월 24일

작업
BaggingClassifier, [n_features_, oob_decision_function_, oob_score_]
BaggingRegressor, [base_estimator_, n_features_, oob_prediction_, oob_score_]

joanaz 에 2019년 08월 24일

BaggingClassifier, [n_features_, oob_decision_function_, oob_score_]
BaggingRegressor, [base_estimator_, n_features_, oob_prediction_, oob_score_]
oob_ 속성은 PR # 14779의 주소이고, n_features_ & base_estimator_는 오 탐지입니다.

joanaz 에 2019년 08월 24일

작업
AdaBoostClassifier, [base_estimator_]

업데이트 : https://github.com/scikit-learn/scikit-learn/pull/14477 에서 이미 수정되었습니다.

nitya 에 2019년 08월 24일

다음 스프린트에이 문제를 권장하지 않거나 훨씬 더 선별 된 버전을 사용해서는 안된다고 생각합니다.

이전 스프린트에 대한 내 경험에 따르면 여전히 많은 오 탐지가 있으며, 결국에는 기여자들에게 공개 속성을 비공개로 만들기 위해 실제로 비난하도록 요청하게되는데, 이는 틀림없이 훨씬 더 어렵습니다. 아무것도).

핑 @amueller @thomasjpfan WDYT?

NicolasHug 에 2019년 09월 03일

다음 스프린트에이 문제를 권장하지 않거나 훨씬 더 선별 된 버전을 사용해서는 안된다고 생각합니다.

https://github.com/numpy/numpydoc/issues/213 에서 제안한 것과 같은 docstring에 대한 일반적인 유효성 검사 도구가 있다면 기여자에게 좀 더 쉬울 것입니다. 일부 속성이 공개되어서는 안되지만 공개된다는 사실을 완전히 다루지는 않는다는 데 동의합니다.

rth 에 2019년 10월 07일

TfidfVectorizer, SpectralEmbedding, SparseRandomProjection 이 업데이트되었습니다.

zioalex 에 2019년 10월 12일

이 문제를 첫 번째 문제로 생각하고 있었지만 스크립트에 나열된 하위 모듈을 무작위로 선택한 후 잘못 문서화 된 것으로 찾은 유일한 클래스는 PLS * 클래스입니다. 그러나 그들은 비공개로 보이는 _pls_.py 파일에 살고 있습니다. 작업을해야합니까 아니면 다른 좋은 첫 번째 문제를 찾아야합니까?

panpiort8 에 2019년 10월 24일

실제 수업이 공개되는 한 자격이 있습니다. 공개 수업은 doc/modules/classes.rst 나열됩니다. PLS * 클래스가 있으므로 자유롭게 문서화하십시오.

NicolasHug 에 2019년 10월 24일

모든 속성을 알파벳순으로 표시하는 것이 합리적입니까? 섹션에 구조를 제공하고 섹션을 읽기 쉽게 만들 것이라고 생각합니다.

pwalchessen 에 2019년 11월 02일

👍1

@pwalchessen 동의합니다, 좋은 생각처럼 들립니다. 직접 언급했듯이 나는 그것을 테스트에 추가 할 것입니다.

amueller 에 2019년 11월 02일

이것들은 여전히 열려 있고 다소 분명해 보입니다.

Docstring Error: Attribute mismatch in RidgeCV
cv_values_
Docstring Error: Attribute mismatch in RidgeClassifier
classes_
Docstring Error: Attribute mismatch in RidgeClassifierCV
classes_
cv_values_
Docstring Error: Attribute mismatch in SkewedChi2Sampler
random_offset_
random_weights_
Docstring Error: Attribute mismatch in PLSCanonical
coef_
x_mean_
x_std_
y_mean_
y_std_
Docstring Error: Attribute mismatch in PLSRegression
x_mean_
x_std_
y_mean_
y_std_
Docstring Error: Attribute mismatch in PLSSVD
x_mean_
x_std_
y_mean_
y_std_
Docstring Error: Attribute mismatch in PassiveAggressiveClassifier
loss_function_
Docstring Error: Attribute mismatch in Perceptron
loss_function_
Docstring Error: Attribute mismatch in PolynomialFeatures
powers_
Docstring Error: Attribute mismatch in QuadraticDiscriminantAnalysis
covariance_
Docstring Error: Attribute mismatch in RBFSampler
random_offset_
random_weights_
Docstring Error: Attribute mismatch in RadiusNeighborsClassifier
n_samples_fit_
outlier_label_
Docstring Error: Attribute mismatch in RadiusNeighborsRegressor
n_samples_fit_
Docstring Error: Attribute mismatch in RadiusNeighborsTransformer
effective_metric_
effective_metric_params_
n_samples_fit_
Docstring Error: Attribute mismatch in ElasticNet
dual_gap_
sparse_coef_
Docstring Error: Attribute mismatch in ElasticNetCV
dual_gap_
Docstring Error: Attribute mismatch in EllipticEnvelope
dist_
raw_covariance_
raw_location_
raw_support_

그리고 더 많은 ...

amueller 에 2019년 11월 02일

추가해야하는 미해결 속성 목록이 업데이트되었습니다.

[] 베이지안 GaussianMixture
- [x] mean_precision_prior
- [] mean_precision_prior_
[] 베이지안 릿지
- [] X_ 오프셋 _
- [] X_ 스케일 _
[] BernoulliNB
- [] coef_ 배열
- [] intercept_
[] 자작 나무
- [] fit_
- [] partial_fit_
[] CCA
- [] coef_ 배열, 모양 (1, n_features) 또는 (n_classes, n_features); 결정 함수의 기능 계수입니다.
- [] x_mean_ : 배열, 모양 (n_features,) 기능에 대한 평균입니다.
- [] x_std_
- [] y_mean_
- [] y_std_
[x] CategoricalNB
- [x] 클래스 _ (클래스 _ : 배열, 모양 (n_ 클래스,)
  
  분류 자에게 알려진 클래스 레이블 목록입니다.
[] ComplementNB
- [] coef_ : 배열, 모양 (1, n_features) 또는 (n_classes, n_features); 결정 함수의 기능 계수입니다.
- [] intercept_
[x] CountVectorizer
- [x] 중지 _ 단어 _
- [x] 어휘 _
[x] DecisionTreeClassifier
- [x] feature_importances_
[] DecisionTreeRegressor
- [] 클래스 _ : 배열 형, 모양 (n_ 클래스,); 고유 한 클래스 레이블
- [] n_classes_ : int; 고유 한 클래스 레이블 수
- [x] feature_importances_
[] DictVectorizer
- [] feature_names_
- [] 어휘 _
[] DummyClassifier
- [] output_2d_
[] DummyRegressor
- [] output_2d_
[] ElasticNet
- [] dual_gap_
- [] sparse_coef_
[] ElasticNetCV
- [] dual_gap_
[] EllipticEnvelope
- [] dist_
- [] 원시 _ 공분산 _
- [] 원시 _ 위치 _
- [] raw_support_
[] ExtraTreeClassifier
- [] feature_importances_
[] ExtraTreeRegressor
- [] 클래스 _ : 배열 형, 모양 (n_ 클래스,); 고유 한 클래스 레이블
- [] feature_importances_
- [] n_classes_ : int; 고유 한 클래스 레이블 수
[] 특징 응집
- [] n_ 구성 요소 _
- [x] 거리 _
[] GaussianProcessClassifier
- [] base_estimator_
- [x] 커널 _
[x] GaussianRandomProjection
- [x] 구성 요소 _
[] GradientBoostingClassifier
- [] max_features_
- [] n_classes_ : int; 고유 한 클래스 수입니다.
- [] n_features_ : int; 사용 된 기능의 수입니다.
- [x] oob_improvement_
- [x] feature_importances_
[] GradientBoostingRegressor
- [] max_features_
- [] n_classes_ : int; 고유 한 클래스 수입니다.
- [] n_estimators_
- [] n_features_ : int; 사용 된 기능의 수입니다.
- [x] oob_improvement_
- [x] feature_importances_
[] HistGradientBoostingClassifier
- [] bin_mapper_
- [ ] 클래스_
- [] do_early_stopping_
- [ ] 손실_
- [] n_features_ : int; 선택한 기능의 수입니다.
- [x] n_iter_
- [] 득점자 _
[] HistGradientBoostingRegressor
- [] bin_mapper_
- [] do_early_stopping_
- [ ] 손실_
- [] n_features_ : int; 선택한 기능의 수입니다.
- []
- [] 득점자 _
[] IncrementalPCA
- [] 배치 _ 크기 _
[] IsolationForest
- [] base_estimator_
- [] estimators_features_
- [x] estimators_samples_
- [] n_features_ : int; 선택한 기능의 수입니다.
[] KernelCenterer
- [] K_fit_all_
- [] K_fit_rows_
[] 커널 밀도
- [] 트리 _
[] LarsCV
- [] 활성 _
[] 올가미
- [] dual_gap_
- [x] 스파 스 _ 코프 _
[] LassoLarsCV
- [] 활성 _
[] LassoLarsIC
- [] alphas_
[] LatentDirichletAllocation
- [x] 경계 _
- [x] doc_topic_prior_
- [] exp_dirichlet_component_
- [] random_state_
[] LocalOutlierFactor
- [] 효과적인 _ 메트릭 _
- [] effective_metric_params_
- [] n_samples_fit_ : int; 피팅 된 데이터의 샘플 수입니다.
[] MDS
- [] 유사성 _ 매트릭스 _
- [] n_iter_ : int; 반복 횟수.
[] MLPClassifier
- [] best_loss_
- [] 손실 _ 곡선 _
- [] t_
[] MLPRegressor
- [] best_loss_
- [] 손실 _ 곡선 _
- [] t_
[] MiniBatchKMeans
- [] 카운트 _
- [] init_size_
- [] n_iter_ : int; 반복 횟수.
[] MultiTaskElasticNet
- [] dual_gap_
- [ ] 주당 순 이익_
- [] sparse_coef_
[] MultiTaskElasticNetCV
- [] dual_gap_
[] MultiTaskLasso
- [] dual_gap_
- [ ] 주당 순 이익_
- [] sparse_coef_
[] MultiTaskLassoCV
- [] dual_gap_
[] OAS
- [] 위치 _
[] OneVsRestClassifier
- [] coef_ : 배열, 모양 (1, n_features) 또는 (n_classes, n_features); 결정 함수의 기능 계수입니다.
- [] intercept_
- [] n_classes_ : int; 고유 한 클래스 수입니다.
[] OrthogonalMatchingPursuit
- [] n_nonzero_coefs_
[] PLSCanonical
- [] coef_ : 배열, 모양 (1, n_features) 또는 (n_classes, n_features); 결정 함수의 기능 계수입니다.
- [] x_mean_ : 부동 ???; 평균
- [] x_std_
- [] y_mean_
- [] y_std_
[] PLS 회귀
- [] x_mean_
- [] x_std_
- [] y_mean_
- [] y_std_
[] PLSSVD
- [] x_mean_
- [] x_std_
- [] y_mean_
- [] y_std_
[] PassiveAggressiveClassifier
- [] 손실 _ 함수 _
[] RBF 샘플러
- [] random_offset_
- [] random_weights_
[] ShrunkCovariance
- [] 수축
[] SkewedChi2Sampler
- [] random_offset_
- [] random_weights_
[] _BaseRidgeCV
- [] 알파 _
- [] coef_
- [] intercept_
[] _ConstantPredictor
- [] y_
[] _RidgeGCV
- [] 알파 _
- [] coef_
- [] dual_coef_
- [] intercept_

jigna-panchal 에 2019년 11월 03일

ExtraTreeRegressor 문서에 feature_importances_ 을 추가하겠습니다.

marielledado 에 2020년 01월 25일

데이터 과학 전공 그룹과 저는 BayesianRidge, [X_offset_, X_scale_] 속성 문서 작업을 시작할 것입니다.

juliapiscioniere 에 2020년 01월 28일

안녕하세요, 저희 기고자 그룹은 다음 작업을 수행 할 것입니다.

PLSSVD
CCA
증분 PCA
MiniBatchKMeans
올가미

phork37 에 2020년 02월 20일

# 16826의 잠재적 수정 사항

BenjaminLiuPenrose 에 2020년 04월 02일

테스트는 # 16286에 추가되었습니다.
현재 건너 뛰는 몇 가지 클래스가 있습니다.
https://github.com/scikit-learn/scikit-learn/blob/753da1de06a764f264c3f5f4817c9190dbe5e021/sklearn/tests/test_docstring_parameters.py#L180

이들 중 일부에는 이미 PR이 있으므로 작업을 시작하기 전에 확인해야합니다.

amueller 에 2020년 05월 29일

이들 중 일부에는 이미 PR이 있으므로 작업을 시작하기 전에 확인해야합니다.

좋은 옵션은 병합되지 않은 공개 PR을 확인하고 완료하는 것입니다.

일반적으로 PR이 2-3 주 이상 활동을하지 않았다면이를 이어 받아 끝내려고 노력하는 것이 좋습니다.

lesteve 에 2020년 06월 23일

이러한 솔루션에 관심이있는 경우 매개 변수가 모두 문서화되었는지 여부를 확인하는 스핑크스 확장을 구현하는 방법이 있습니다 (예 : https://github.com/sdpython/pyquickhelper/blob 참조). /master/src/pyquickhelper/sphinxext/sphinx_docassert_extension.py). scikit-learn 문서에 사용자 지정 문서를 추가하는 것이 유용 할 수 있습니다.

sdpython 에 2020년 06월 23일

🎉1

@sdpython ,

cmarmo 에 2020년 06월 23일

흥미 롭군요!

IIRC에는 모든 속성이 문서화되었는지 확인하는 공통 테스트가 있습니다. https://github.com/scikit-learn/scikit-learn/pull/16286 에 추가되었습니다

어떤 접근 방식이 더 바람직한 지에 대한 정보에 입각 한 의견은 없지만 누락 된 매개 변수를 문서화하는 것이 검사 방법을 결정하는 것보다 우선 순위가 더 높을 것입니다.

lesteve 에 2020년 06월 23일

스핑크스에서 그렇게 할 때의 문제는 우리의 경우 문서를 작성하는 데 오랜 시간이 걸리므로 (모든 예제를 생성하기 때문에) 단위 테스트 또는 독립 실행 형 도구를 사용하기가 더 쉽습니다. 이전에 https://github.com/scikit-learn/scikit-learn/issues/15440에서 numpydoc 유효성 검사 를 사용 검사 는 https://github.com/terrencepreilly에서 수행 할 수 있습니다. / darglint. 따라서 독 스트링에 대해 5 가지 다른 유효성 검사 도구를 사용하는 상황도 피해야합니다. :)

rth 에 2020년 06월 23일

예를 들어 pytest를 사용하여 결과를 확인하는 기능이 마음에 듭니다.

pytest -v  --runxfail -k IsolationForest sklearn/tests/test_docstring_parameters.py

따라서 스핑크스 빌드를 변경할 필요가 없을 수도 있습니다.

ogrisel 에 2020년 06월 23일

어떤 속성 독 스트링이 아직 누락되었는지 확인했습니다 (위의 목록은 오래되었습니다). 다음은 내가 찾은 것입니다.

BayesianGaussianMixture, [mean_precision_prior]
BayesianRidge, [X_offset_, X_scale_]
BernoulliNB, [coef_, intercept_]
자작 나무, [fit_, partial_fit_]
CCA, [x_mean_, x_std_, y_mean_, y_std_]
DecisionTreeRegressor, [classes_, n_classes_]
DummyClassifier, [output_2d_]
DummyRegressor, [output_2d_]
ElasticNet, [dual_gap_]
ElasticNetCV, [dual_gap_]
ExtraTreeRegressor, [classes_, n_classes_]
FeatureAgglomeration, [n_components_]
LarsCV, [활성 _]
올가미, [dual_gap_]
LassoLarsCV, [활성 _]
LassoLarsIC, [alphas_]
MiniBatchKMeans, [counts_, init_size_, n_iter_]
MultiTaskElasticNet, [dual_gap_, eps_, sparse_coef_]
MultiTaskElasticNetCV, [dual_gap_]
MultiTaskLasso, [dual_gap_, eps_, sparse_coef_]
MultiTaskLassoCV, [dual_gap_]
NuSVR, [probA_, probB_]
OneClassSVM, [probA_, probB_]
OneVsRestClassifier, [coef_, intercept_]
OrthogonalMatchingPursuit, [n_nonzero_coefs_]
PLSCanonical, [x_mean_, x_std_, y_mean_, y_std_]
PLSSVD, [x_mean_, x_std_, y_mean_, y_std_]
SVR, [probA_, probB_]

marenwestermann 에 2020년 06월 26일

@marenwestermann 감사합니다!

cmarmo 에 2020년 06월 26일

MiniBatchKMeans 작업 중입니다.

jeremiedbb 에 2020년 07월 08일

올가미 작업 중입니다.

marenwestermann 에 2020년 07월 10일

이제 MultiTaskElasticNet 및 MultiTaskLasso에 sparse_coef_ 속성을 추가하는 중입니다.

marenwestermann 에 2020년 07월 10일

저는 LarsCV에서 일하고 있습니다.

marenwestermann 에 2020년 07월 10일

@thomasjpfan SVR 및 OneClassSVM 클래스에서 말합니다.
"probA_ 속성은 버전 0.23에서 더 이상 사용되지 않으며 버전 0.25에서 제거됩니다." 과
"probB_ 속성은 버전 0.23에서 더 이상 사용되지 않으며 버전 0.25에서 제거됩니다."

따라서 이러한 속성은 더 이상 문서가 필요하지 않습니다.
여기에서이 두 속성은 NuSVR 클래스에서도 더 이상 사용되지 않습니까?

marenwestermann 에 2020년 08월 07일

ExtraTreeRegressor에 대한 classes_ 및 n_classes_ 속성은 오 탐지입니다.

marenwestermann 에 2020년 09월 11일

따라서 이러한 속성은 더 이상 문서가 필요하지 않습니다.
여기서부터이 두 속성은 NuSVR 클래스에서도 더 이상 사용되지 않습니까?

우리는 그것들을 더 이상 사용하지 않기 때문에 문서화 할 필요가 없다고 말할 것입니다.

ExtraTreeRegressor에 대한 classes_ 및 n_classes_ 속성은 거짓 긍정입니다.

예, 그것들은 더 이상 사용되지 않고 아직 제거되지 않은 경우 제거해야합니다.

thomasjpfan 에 2020년 09월 11일

DecisionTreeRegressor 수업 내용 :
"n_classes_ 속성은 버전 0.22에서 더 이상 사용되지 않으며 0.24에서 제거됩니다."
"classes_ 속성은 버전 0.22에서 더 이상 사용되지 않으며 0.24에서 제거됩니다."

따라서 이러한 속성도 문서화가 필요하지 않습니까?

Abilityguy 에 2020년 09월 16일

따라서 이러한 속성도 문서화가 필요하지 않습니까?

오른쪽 @Abilityguy , 지적 해 주셔서 감사합니다.

cmarmo 에 2020년 09월 16일

_RidgeGCV에서 아래 불일치를 볼 수 있습니다.
독 스트링 오류 : _RidgeGCV의 속성 불일치
alpha_
최고 점수_
coef_
dual_coef_
intercept_
n_features_in_

그리고 _BaseRidgeCV에서 :
독 스트링 오류 : _BaseRidgeCV의 속성 불일치
alpha_
최고 점수_
coef_
intercept_
n_features_in_

내가 받아도 될까요? 나는 첫 번째 타이머이며 기여하고 싶습니다.

mynkdsi1011 에 2020년 09월 24일

@marenwestermann 클래스 FeatureAgglomeration에서, 버전 0.21에서 n_components_를 대체하기 위해 n_connected_components_가 추가되었는데, n_components_가 거짓 양성일 것입니다 ..?

srivathsa729 에 2020년 09월 26일

내 이해에서 @ srivathsa729 예. 그러나 핵심 개발자 중 한 명이 다시 확인할 수 있다면 좋을 것입니다.

marenwestermann 에 2020년 09월 29일

ElasticNet을 사용하겠습니다.

disha4u 에 2020년 10월 05일

BayesianRidge에 대한 X_offset_ 및 X_scale_ 속성에 대한 문서가 # 18607과 함께 추가되었습니다.

marenwestermann 에 2020년 11월 04일

👍1

output_2d_ 속성은 DummyClassifier 및 DummyRegressor에서 더 이상 사용되지 않습니다 (# 14933 참조).

marenwestermann 에 2020년 11월 05일

이 PR 상단에서 @amueller 가 제공 한 스크립트를 실행했습니다 (일이 움직이기 때문에 코드를 약간 수정해야 함). # 16112에 도입 된 n_features_in_ 를 제외하고 문서화해야 할 속성을 더 이상 찾을 수 없습니다. 이 속성은 소개 된 모든 클래스에서 문서화되지 않았습니다. 문서화해야합니까?
핑 @NicolasHug

marenwestermann 에 2020년 11월 09일

이 페이지가 도움이 되었나요?

0 / 5 - 0 등급

Scikit-learn: 모든 속성이 문서화되었는지 확인

가장 유용한 댓글

각 추정기에 대한 속성 독 스트링 누락

PR에서이 문제를 참조하세요.

모든 79 댓글

각 추정기에 대한 속성 독 스트링 누락

PR에서이 문제를 참조하세요.

관련 문제