0.1.6

What's Changed

• Update docstrings by @nateraw in #53
• 🔧 update read/write encoding for cards by @nateraw in #54
• 🔖 prepare release 0.1.6 by @nateraw in #55

Full Changelog: v0.1.5...v0.1.6

0.1.5

Some minor updates in preparation for porting this repo's content over to huggingface_hub.

What's Changed

• Update card validation endpoint by @nateraw in #45
• Update RepoCard load and push functions by @nateraw in #51
• Prepare release 0.1.5 by @nateraw in #52

Full Changelog: v0.1.4...v0.1.5

0.1.4

You can now create pull requests when pushing a card up to the hub!

from modelcards import CardData, ModelCard

repo_id = "nateraw/my-cool-model-with-card"

# Initialize card from default template, including card metadata 📝
card = ModelCard.from_template(
    card_data=CardData(  # Card metadata object that will be converted to YAML block
        language='en',
        license='mit',
        library_name='timm',
        tags=['image-classification', 'resnet'],
        datasets='beans',
        metrics=['accuracy', 'f1'],
    ),
    model_id=repo_id.split('/')[-1],  # Jinja template kwarg
    model_description="Some really helpful description...",  # Jinja template kwarg
)

# Push To Hugging Face Hub, creating a PR 🔥
card.push_to_hub(repo_id, create_pr=True)

What's Changed

• Add create_pr flag when uploading cards by @nateraw in #38
• Add Push To Hub Tests by @nateraw in #39
• Add commit message and description to RepoCard.push_to_hub by @nateraw in #40
• Update version tag to 0.1.4 by @nateraw in #41

Full Changelog: v0.1.3...v0.1.4

0.1.3

Adding release to include modelcard validation, which happens on push_to_hub. It validates against Hugging Face's validation logic to make sure the card will push successfully.

What's Changed

• Add modelcard validation by hitting hub endpoint by @nateraw in #35
• Prepare release 0.1.3 by @nateraw in #37

Full Changelog: v0.1.2...v0.1.3

0.1.2

Something went wrong with last release to PyPi, so releasing another.

What's Changed

• Update version tag by @nateraw in #33
• Bump version to 0.1.2 by @nateraw in #34

Full Changelog: v0.1.1...v0.1.2

v0.1.1

Small release to include token arg when pushing to hub so this package can be used in the model card creator app.

What's Changed

• Fix libraries link by @nateraw in #27
• Add token arg to repocard push_to_hub by @nateraw in #31

Full Changelog: v0.1.0...v0.1.1

0.1.0

What's Changed

• Allow for missing metadata, invalid model-index by @nateraw in #15
• Update model name when pushing to hub by @nateraw in #16
• Allow for arbitrary kwargs in CardData by @nateraw in #18
• Deep copy card data when calling to_dict by @nateraw in #23
• Update readme.md by @nateraw in #24
• Use CardData directly in ModelCard.from_template by @nateraw in #25
• Bump version to 0.1.0 by @nateraw in #26

Full Changelog: v0.0.4...v0.1.0

0.0.4

What's Changed

• MNT add pre-commit-hooks by @adrinjalali in #7
• Add CardData and EvalResult by @nateraw in #5
• Add to known_third_party in setup.cfg by @nateraw in #8
• Add docstrings by @nateraw in #9
• Add doctests by @nateraw in #10
• Bump version to 0.0.4 by @nateraw in #11

New Contributors

• @adrinjalali made their first contribution in #7

Full Changelog: v0.0.3...v0.0.4

0.0.3

Added very minimal CI tests and fixed bug where card data wasn't updated on save.

0.0.2

Hopefully get package data to work with MANIFEST.in 🙄