Comments (6)
The format / style guide would be the same as what we already have in the user guide. You might wanna have a look at our contributing guide, specifically the documentation part: https://scikit-learn.org/dev/developers/contributing.html#documentation
from scikit-learn.
Thank you for raising this issue! It's true that the current user guide can be a bit overwhelming for beginners who are new to machine learning.
I really like the suggestion of creating a new section something like ("Before you get started"/"Getting Started") that includes content highlighted in the 'basics tutorial.' This could significantly improve the onboarding experience for new users.
I'm familiar with scikit-learn and have experience writing technical documentation. I'd be happy to help develop this section to incorporate these introductory concepts.
Is there a specific format or style guide for contributing to the user guide? I'm happy to follow any existing guidelines and collaborate with you on this effort.
from scikit-learn.
I noted that the current Getting Started (1) section outside User Guide covers basic commands re: model training and evaluation.
While the tutorial (2) covers brief foundational ML theory.
Combining (1) and (2) would give the users a more comprehensive starting point, and make them better prepared for the User Guide. I can get started on one section that covers that.
If you have any initial thoughts (topics, structure) & a timeline for this, please let me know. Thanks!
from scikit-learn.
Hey can I work on this if this issue's open?
from scikit-learn.
@hoipranav this is not suitable as a first contribution. I suggest you start with easier issues or to continue pull requests that are marked as easy and stalled
from scikit-learn.
Okay @adrinjalali I'll surely look into some easier or stalled PR. Thank you!
from scikit-learn.
Related Issues (20)
- ⚠️ CI failed on Wheel builder (last failure: Aug 31, 2024) ⚠️ HOT 1
- Compiling Fails due to sklearn/metrics/pairwise.py HOT 7
- z HOT 1
- C regularization parameter error when assigned infinity HOT 3
- Implementation of fit_transform in ColumnTransformer HOT 1
- CI CUDA CI not running in lock-file update automated PR HOT 4
- Running RFECV.fit inside joblib.Parallel causes ValueError or AttributeError HOT 2
- Big problem with scikit-learn on Python311 when installing (FreeBSD) HOT 2
- Include T-Processes Subclass of Gaussian-Processes HOT 6
- Discrepancy between .fit_transform() and .transform() methods in the LLE module HOT 1
- Ensure RandomizedSearchCV (and other optimizers) skips duplicated hyperparameter combinations HOT 2
- Importing sklearn takes too much time compared to other imports except spaCy HOT 7
- ⚠️ CI failed on Linux_Docker.debian_32bit (last failure: Sep 08, 2024) ⚠️ HOT 2
- DOC: Add Bioconductor's package to the list of scikit-learn Related Projects HOT 1
- make_regression always generates positive coefficients HOT 3
- Adding timeseries-tailored baseline strategy to Dummy* estimators. Making them more intelligent with strategy="best". HOT 6
- Misleading variable name for the example of AUC calculation HOT 4
- SimpleImputer does not drop a column full of `np.nan` even when `keep_empty_feature=False` HOT 4
- ⚠️ CI failed on Linux_free_threaded.pylatest_pip_free_threaded (last failure: Sep 13, 2024) ⚠️ HOT 4
- ⚠️ CI failed on Wheel builder (last failure: Sep 13, 2024) ⚠️ HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from scikit-learn.