HashSlap-Summer-of-Code/ml-core

Create a Comprehensive ML Tutorial Series

Offen

#8 geöffnet am 18.06.2025

Auf GitHub ansehenContributor Guide
 (2 Kommentare) (0 Reaktionen) (1 zugewiesene Person)Jupyter Notebook (11 Forks)auto 404
Intermediateenhancementhacktoberfesthssoc

Repository-Metriken

Stars
 (3 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

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.

Contributor Guide

Research-Richtung
Überprüfe die Ordnerstruktur und identifiziere Unterordner ohne README Dateien. Schreibe dann für jeden einen README im Tutorial Stil, der eine Schritt für Schritt Erklärung einer wichtigen Implementierung, Beispiel Eingabe/Ausgabe und Links zu Ressourcen enthält. Stelle sicher, dass der vorhandene Code korrekt ausgeführt wird. Optional füge Diagramme mit ASCII oder Markdown Bildern hinzu.
Tech Stack
python
Domain
machine learningdocumentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPythonBasic ML concepts
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85