modelscope/twinkle
Grade a repo

0

/ 100

GradeB

Polished and well engineered. Punching above its star count.

Top 14% of 5,156 graded repos

Twinkle✨: Training workbench to make your model glow.

Documentation95
Engineering82
Health98
Python241Apache-2.01mo ago

Top fixes

Highest-impact changes first, ranked by point weight

7 to address
  1. 1
    Tests18pt

    Wire your tests to a documented command (e.g. a test script in your build config) so the suite is reproducible.

  2. 2
    Install and run instructions9pt

    Add a .env.example listing all required environment variables so contributors know what to set up.

  3. 3
    Reproducibility6pt

    Add .github/dependabot.yml with at least one package-ecosystem entry so dependencies are updated automatically.

  4. 4
    Dependency manifest6pt

    Add a [project.urls] table (Homepage, Repository) so PyPI links back to your project.

Working through the fixes? Let every push regrade itself.

The free GitHub App rescans this repo on every push and posts the grade as a commit check, so the score climbs without coming back to rescan by hand.

Install the GitHub App

Scorecard

Every check, grouped by category and sorted worst-first

Documentation

95

Contributing guide5pt89

Contributing guide is detailed and thorough.

Install and run instructions9pt90

README documents how to install the project.

README12pt100

README is present.

License6pt100

Licensed under Apache-2.0.

Engineering

82

Linting and formatting5pt0

No linter or formatter configured.

→ Add [tool.ruff] to pyproject.toml. Ruff handles linting and formatting in one tool and replaces flake8, isort, and black.

Reproducibility6pt80

Lockfile present (poetry.lock). Installs are reproducible.

Tests18pt85

Test files detected (tests).

CI/CD14pt100

CI is configured (.github/workflows/citest_npu.yaml).

Issue and PR templates6pt100

Issue or PR templates present.

Project health

98

Dependency manifest6pt93

Dependency manifest found (pyproject.toml).

Repository metadata5pt100

Repository has a description.

Activity5pt100

Actively maintained (pushed within the last month).

Housekeeping3pt100

.gitignore present.

Repository health signals

Activity, community, and responsiveness at scan time

Activity

  • -
    Commits (30d / 90d)
  • 33
    Forks
  • 8
    Releaseslatest 1mo ago

Community

  • -
    Community health
  • -
    authors own >50% of commits
  • 241
    Watchers

Responsiveness

  • <1h
    Median issue response
  • <1h
    Median PR merge time
  • 5
    Open issues
Repository files26 root entries
  • .dev_scripts
  • .github
    Good: CI is configured (.github/workflows/citest_npu.yaml).
    Good: Issue or PR templates present.
    Good: Security policy present.
  • assets
  • client_tools
  • cmake
  • cookbook
  • docs
  • notebook
  • src
  • tests
    Good: Test files detected (tests).
  • .gitignore
    Good: .gitignore present.
  • .pre-commit-config.yaml
  • CODE_OF_CONDUCT.md
    Good: Code of conduct present.
  • CONTRIBUTING_CN.md
  • CONTRIBUTING.md
    Good: Contributing guide is detailed and thorough.
    Good: Contributing guide includes setup/install instructions.
    Issue: Contributing guide lacks a code style section (−8 pts).Fix: Describe your linting/formatting rules and how to run them.
    Issue: Contributing guide lacks a testing section (−8 pts).Fix: Show contributors how to run the test suite (e.g. npm test, pytest, cargo test).
    Good: Contributing guide describes the PR/review workflow.
    Good: Contributing guide includes code examples.
  • Dockerfile
    Good: Environment pinned via Dockerfile.
  • INSTALL_CLIENT.ps1
  • INSTALL_CLIENT.sh
  • INSTALL_MEGATRON.sh
  • LICENSE
    Good: Licensed under Apache-2.0.
  • poetry.lock
    Good: Lockfile present (poetry.lock). Installs are reproducible.
  • pyproject.toml
    Good: Dependency manifest found (pyproject.toml).
  • README_ZH.md
    Good: README is present.
    Good: README is well structured with multiple sections.
    Good: README includes screenshots or visuals. Great for first impressions.
    Good: README has code examples.
    Good: README links to a live demo or deployed app.
    Good: README includes status badges.
    Good: README documents how to install the project.
    Good: README documents how to run the project.
  • README.md
  • ROADMAP.md
  • setup.cfg
RepoGrade badge preview

Add this badge to your README

It updates automatically each time the repo is re-graded.

[![RepoGrade](https://www.repo-grade.com/api/badge/modelscope/twinkle)](https://www.repo-grade.com/report/modelscope/twinkle)

More graded Python repos