How do we include python documentation in doc-strings?
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 25/100
- Tipo de issue
- Documentación
- Claridad
- Necesita aclaración
- Estado de actividad
- Estancado
Línea de trabajo
Comienza por src/macros.jl alrededor de la línea 141 para entender cuándo se generan objetos de Python en tiempo de ejecución. Investiga cómo init y los artefactos de Julia podrían cargar documentación generada por separado, y determina cómo funcionaría la sincronización. Se considera terminado cuando los docstrings de los modelos de MLJ incluyen la documentación de Python sin importar cada modelo durante using.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
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?
- Lenguaje dominante
- Julia
- Estrellas
- 14
- Forks
- 8
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de JuliaAI/MLJScikitLearnInterface.jl
-
enhancement
Dificultad 3/5 1-2 días Aptitud para principiantes 48/100
JuliaAI/MLJScikitLearnInterface.jl#74 · 1 comentario ·
-
enhancement next breaking release
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
JuliaAI/MLJScikitLearnInterface.jl#47 · 1 comentario ·
-
Passing return_std to predictAbierto
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
JuliaAI/MLJScikitLearnInterface.jl#46 · 3 comentarios ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
-
Dificultad 4/5 3-5 días Aptitud para principiantes 38/100
Todos los issues de JuliaAI/MLJScikitLearnInterface.jl
Issues similares
-
bignums
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
JuliaNLSolvers/NLsolve.jl#319 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
gridap/GridapPETSc.jl#129 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100