nliced/deep-learning

0

/ 100

Documentation41
Engineering38
Health42
0MIT6y ago
Grade a repo

Lots of room to improve. Start with a README and CI.

Documentation

41

Install and run instructions9pt0

No install instructions found in the README (−45 pts).

→ Add a section showing how to install dependencies.

README12pt30

README is present.

Contributing guide5pt72

CONTRIBUTING guide found.

License6pt100

Licensed under MIT.

Engineering

38

CI/CD14pt0

No CI configuration detected in this repository.

→ If your CI lives elsewhere (a private repo that builds this one) or this project is itself a CI/CD tool, mark this check Not Applicable. Otherwise add a GitHub Actions workflow that runs tests on each push. It takes 15 minutes and reassures contributors their changes won't break things.

Linting and formatting5pt0

No linter or formatter config found.

→ Add a linter config such as .eslintrc.json, .prettierrc, ruff.toml, or .golangci.yml to enforce consistent code style.

Issue and PR templates6pt0

No issue or PR templates found (−100 pts).

→ Add .github/ISSUE_TEMPLATE/ with bug_report.md and feature_request.md to guide contributors. It dramatically improves issue quality.

Reproducibility6pt70

Lockfile present (First_Neural_Network-P1/requirements.txt). Installs are reproducible.

Tests18pt80

Test files detected (GPT2-HarryPotter-Training/examples/summarization/utils_summarization_test.py).

Project health

42

Repository metadata5pt0

No repository description set on GitHub (−60 pts).

→ Add a one-line description in the repo Settings → About. It appears in search results and social previews.

Activity5pt5

No pushes in over 2 years. Looks unmaintained (−95 pts).

→ A recent commit signals the project is alive and worth using.

Housekeeping3pt60

.gitignore present.

Dependency manifest6pt100

Dependency manifest found (First_Neural_Network-P1/requirements.txt).

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • —
    Commits (30d / 90d)
  • 0
    Forks
  • 0
    Releases

Community

  • —
    Community health
  • —
    authors own >50% of commits
  • 0
    Watchers

Responsiveness

  • —
    Median issue response
  • —
    Median PR merge time
  • 0
    Open issues
Repository files35 root entries
  • COVID19_Plotly_Visualization
  • crack_detection
  • Custom_Mask_RCNN
  • cvpr2019
  • deeplab
  • depth_estimation
  • detecting_social_distancing_violation
  • Dog-breed-classifier
  • First_Neural_Network-P1
    Good: Lockfile present (First_Neural_Network-P1/requirements.txt). Installs are reproducible.
    Good: Dependency manifest found (First_Neural_Network-P1/requirements.txt).
  • GPT2-HarryPotter-Training
    Good: Test files detected (GPT2-HarryPotter-Training/examples/summarization/utils_summarization_test.py).
    Good: .gitignore present.
    Issue: Build artifacts or local files may be committed (GPT2-HarryPotter-Training/examples/__pycache__/run_squad.cpython-37.pyc) (−40 pts).Fix: Remove them and add to .gitignore.
  • handwriting_recognition
  • Image Classification CIFAR
  • intro_to_rnn
  • Kaggle Fisheries
  • Knowledge-Graph-Resumes
  • march_madness_team_shot
    Good: CONTRIBUTING guide found.
    Issue: CONTRIBUTING guide contents could not be read (−28 pts vs a readable file).Fix: Move the file to the repo root or docs/CONTRIBUTING.md so its setup, style, test, and PR sections can be graded.
  • Mask_RCNN
  • mask_rcnn_damage_detection
  • parking_spots_detector
  • qa_chat_bot
  • Question_Answering_coronavirus
  • resnet_keras
  • retinanet_aerial_detection
  • RNN_text_generation
  • segmentation_with_RGBD
  • sentiment_classification_RNN
  • soccer_area_of_action
  • soccer_team_prediction
  • tensorflow_toy_detector
  • text_classification_with_BERT
  • topic_modeling
  • word2vec_skipgram
  • LICENSE
    Good: Licensed under MIT.
  • Object_Detection_Tensorflow_API.ipynb
  • README.md
    Good: README is present.
    Issue: README is fairly short (−10 pts). At 400+ chars you get partial credit; 1,500+ earns the full +20 pts.Fix: Expand with a description, install steps, usage, and examples.
    Issue: README has little structure (−15 pts). Add 2-3 headings for +8 pts; 4+ earns +15 pts.Fix: Break it into sections (Overview, Install, Usage, Contributing) using Markdown headings.
    Issue: No screenshots or images in the README (−20 pts).Fix: Add a GIF, screenshot, or logo image. It is the fastest way to show what your project does.
    Issue: README has no code examples (−15 pts).Fix: Show a quick-start snippet so contributors can see what using your project looks like.
    Good: README links to a live demo or deployed app.
    Issue: No status badges in the README (−10 pts).Fix: Add CI/build status badges from shields.io or your CI provider to signal project health.
    Issue: No install instructions found in the README (−45 pts).Fix: Add a section showing how to install dependencies.
    Issue: No run or usage instructions found (−45 pts).Fix: Add a section showing how to start or use the project.