HashSlap-Summer-of-Code/ml-core

Create a Comprehensive ML Tutorial Series

Ouverte

#8 ouverte le 18 juin 2025

Voir sur GitHubGuide contributeur
 (2 commentaires) (0 réaction) (1 personne assignée)Jupyter Notebook (11 forks)auto 404
Intermediateenhancementhacktoberfesthssoc

Métriques du dépôt

Stars
 (3 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

Description:
Many folders contain valuable code but lack beginner-friendly explanations. Add tutorial-style documentation in each folder to help users understand the theory and implementation of the algorithms.

Expected Tasks:

  • Add a README.md to subfolders like computer-vision, data-analysis, etc., containing:
    • A brief introduction to the domain.
    • A step-by-step walkthrough of a key implementation (e.g., how KNN works).
    • Sample input and expected output.
    • Hyperlink to helpful resources (e.g., scikit-learn, Coursera, blog posts).
  • Ensure the code runs correctly with the tutorial.
  • Add a table of contents or index in the root README.md to guide users to these tutorials.

Stretch Goal:

  • Add visual diagrams or flowcharts using Markdown-supported images or ASCII diagrams.

Guide contributeur

Direction de recherche
Vérifie la structure des dossiers et identifie les sous dossiers qui manquent de fichiers README. Ensuite, rédige un README de style tutoriel pour chacun, incluant une explication étape par étape d'une implémentation clé, des exemples d'entrée/sortie et des liens vers des ressources. Assure toi que le code existant s'exécute correctement. Optionnellement, ajoute des diagrammes visuels en utilisant ASCII ou des images Markdown.
Stack technique
python
Domaine
machine learningdocumentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPythonBasic ML concepts
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85