How do we include python documentation in doc-strings?

Đang mở
  • Có gì không ổn?
#37 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức phù hợp với người mới
25/100
Loại issue
Tài liệu
Độ rõ ràng
Cần làm rõ
Mức độ hoạt động
Đình trệ
Công nghệ
julia, python, scikit-learn
Lĩnh vực
documentation, machine-learning

Hướng nghiên cứu

Bắt đầu với src/macros.jl quanh dòng 141 để hiểu khi nào các đối tượng Python được tạo trong thời gian chạy. Điều tra cách init và các artefact Julia có thể tải tài liệu được tạo riêng, đồng thời xác định cơ chế đồng bộ hóa sẽ hoạt động như thế nào. Công việc được xem là hoàn tất khi docstring của các model MLJ bao gồm tài liệu Python mà không cần import mọi model trong quá trình using.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Once you import a python model using Sckitlearn.jl the documentation is available:

julia> @sk_import linear_model: Lasso
PyObject <class 'sklearn.linear_model._coordinate_descent.Lasso'>

help?> Lasso
search: Lasso LassoRegressor LassoCVRegressor LassoLarsRegressor LassoLarsICRegressor LassoLarsCVRegressor

Linear Model trained with L1 prior as regularizer (aka the Lasso)

    The optimization objective for Lasso is::

        (1 / (2 * n_samples)) * ||y - Xw||^2_2 + alpha * ||w||_1

...

However, we do not want using MLJScikitLearnInterface to generate every python model to get this documentation, for inclusion in MLJ model docstrings. (Currently, the python objects are only generated at run time, when someone calls fit on the MLJ model; see here). So I guess we generate this documentation separately and have __init__ load it in? Then there is the problem of synchronisation. Can julia artefacts help here?

Ngôn ngữ chính
Julia
Star
14
Fork
8
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của JuliaAI/MLJScikitLearnInterface.jl

Tất cả issue của JuliaAI/MLJScikitLearnInterface.jl

Issue tương tự

Thêm issue về Julia

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.