HashSlap-Summer-of-Code/ml-core

Create a Comprehensive ML Tutorial Series

Aperta

#8 aperta il 18 giu 2025

Vedi su GitHubGuida contributor
 (2 commenti) (0 reazioni) (1 assegnatario)Jupyter Notebook (11 fork)auto 404
Intermediateenhancementhacktoberfesthssoc

Metriche repository

Star
 (3 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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.

Guida contributor

Direzione di ricerca
Controlla la struttura delle cartelle e identifica quali sottocartelle mancano di file README. Quindi, scrivi un README in stile tutorial per ciascuna, includendo una spiegazione passo passo di un'implementazione chiave, input/output di esempio e collegamenti a risorse. Assicurati che il codice esistente funzioni correttamente. Opzionalmente, aggiungi diagrammi visivi usando ASCII o immagini Markdown.
Tech stack
python
Dominio
machine learningdocumentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPythonBasic ML concepts
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85