https://github.com/wakame1367/kaggle_petfinder

https://github.com/wakame1367/kaggle_petfinder

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/wakame1367/kaggle_petfinder
• Owner: wakame1367
• License: mit
• Created: 2020-11-05T07:20:01.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2020-11-05T08:03:59.000Z (about 4 years ago)
• Last Synced: 2023-03-10T20:56:56.660Z (almost 2 years ago)
• Language: Python
• Size: 19.5 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# kaggle_submission_pipeline_template

This repository is influenced by [kaggle-script-template](https://github.com/lopuhin/kaggle-script-template).

The difference between this template and this one is that we have added GithubActions to submit the code using the KaggleAPI.

## Example

This repository has been generated using a [kaggle_submission_pipeline_template](https://github.com/wakamezake/kaggle_submission_pipeline_template).

Here's a link between the repository created using this template and the Kaggle Notebook generated by GithubActions.

## Correctional point

Here's a summary of the modifications to be made when using a template.

### Code

- Change name of the directory **easy_gold** to **{my_package_name}**

- Also change the **easy_gold** part of each code to **{my_package_name}**

  - https://github.com/wakamezake/kaggle_submission_pipeline_template/blob/286e0d2bd544ac1ebffba6198b1474a3a8bfd23e/script_template.py#L24

  - https://github.com/wakamezake/kaggle_submission_pipeline_template/blob/286e0d2bd544ac1ebffba6198b1474a3a8bfd23e/setup.py#L3-L6

### Github Secrets

Set an API token in Github Secrets before running Github Actions.

See [Kaggle Public API](https://www.kaggle.com/docs/api) to generate an API token.

> In order to use the Kaggle’s public API, you must first authenticate using an API token. From the site header, click on your user profile picture, then on “My Account” from the dropdown menu. This will take you to your account settings at https://www.kaggle.com/account. Scroll down to the section of the page labelled API:

To create a new token, click on the “Create New API Token” button. This will download a fresh authentication token onto your machine.

See [Github - encrypted-secrets](https://docs.github.com/en/free-pro-team@latest/actions/reference/encrypted-secrets) about Github Secrets.

### Github Action([upload.yml](https://github.com/wakamezake/kaggle_submission_pipeline_template/blob/master/.github/workflows/upload.yml))

Please refer to the following [Kernel-Metadata](https://github.com/Kaggle/kaggle-api/wiki/Kernel-Metadata) for parameter settings.

See the following [Clean_URL#Slug](https://en.wikipedia.org/wiki/Clean_URL#Slug) to learn how to write a **slug**.

- Set the following parameters

  - https://github.com/wakamezake/kaggle_submission_pipeline_template/blob/286e0d2bd544ac1ebffba6198b1474a3a8bfd23e/.github/workflows/upload.yml#L32-L44

## License

[MIT](https://github.com/wakamezake/kaggle_submission_pipeline_template/blob/master/LICENSE)