GithubHelp home page GithubHelp logo

DOC Beginners Tutorial about scikit-learn HOT 6 OPEN

adrinjalali avatar adrinjalali commented on September 28, 2024 3
DOC Beginners Tutorial

from scikit-learn.

Comments (6)

adrinjalali avatar adrinjalali commented on September 28, 2024 1

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.

singhstack avatar singhstack commented on September 28, 2024

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.

singhstack avatar singhstack commented on September 28, 2024

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.

hoipranav avatar hoipranav commented on September 28, 2024

Hey can I work on this if this issue's open?

from scikit-learn.

adrinjalali avatar adrinjalali commented on September 28, 2024

@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.

hoipranav avatar hoipranav commented on September 28, 2024

Okay @adrinjalali I'll surely look into some easier or stalled PR. Thank you!

from scikit-learn.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.