Skip to content
Public template

About

Template repository for CCAI's tutorials track

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

26 Commits

Folders and files

Repository files navigation

[Title of Contribution]

Python Jupyter Notebook MIT License

[Required badges consist of 1) programming language + version 2) Jupyter, 3) main ML/data-science framework and 4) license. We do not require authors to create a badge for every dependency. We encourage authors to keep the top 3-5 significant dependencies. Badge urls can be found on shields.io/badges]

Abstract

[Provide an abstract describing the tutorial.]

Authors:

Provide a bulleted list of all author names, affiliations, and contact links.

  • [author 1 fullname], [Affiliation/Institution] , [contact email]
  • [author 2 fullname], [Affiliation/Institution] , [contact email]

Reminder for Round II reviews please keep all tutorial materials anonymized to support the double-blind review process.

Originally presented at the [insert CCAI event or workshop full name with the year].

Learning Objectives

After completing this tutorial, participants should be able to:

  1. [Learning objective]
  2. [Learning objective]
  3. [Learning Objective]

Intended Audience

[Describe the intended audience and please be as specific as possible, especially with respect to their expected background.]

Prerequisites

Participants should be familiar with:

  • [Prerequisite]
  • [Prerequisite]
  • [Prerequisite]

Tutorial walkthrough video

  ➡️ Video URL Duration: [XX minutes]


Repository Contents

 

Resource Description
notebook/ Jupyter notebook
model-card/ Model documentation (if applicable)
datasheet/ Dataset documentation (if applicable)
emissions-reporting/ Energy/carbon reporting
figures/ Images and figures (optional)
data/ Dataset sample (optional)

Software Requirements

  Primary language: [Python / R / Julia / Other]   Language version: [e.g., Python 3.12]  

Major Packages

  • [package] [version]
  • [package] [version]
  • [package] [version]  

See requirements.txt for the complete environment.


Access this tutorial

We recommend executing this notebook in a Colab environment to gain access to GPUs and to manage all necessary dependencies. Open In Colab

To run locally, see:

➡️ notebook/[final_notebook_name_without_version.ipynb]

Estimated time to execute end-to-end: [insert runtime here].

Last successfully tested: [YYYY-MM-DD]

Model Information

This submission [does/does not] involve a machine-learning model.

[If the tutorial trains, fine-tunes, adapts, evaluates, or demonstrates an AI/ML model please provide a model-card. A description of model-cards is provided here.]

If applicable, see:

➡️ model-card/MODEL_CARD.md

Dataset Information

This submission [does/does not] use a dataset.

[If the tutorial utilizes a dataset, please provide a datasheet. A description of datasheets is provided here.]

If applicable, see:

➡️ datasheet/DATASHEET.md

Sustainbility/Carbon Emissions

Carbon emissions associated with the computational experiments were measured using [CodeCarbon or emissions tracking tool of choice].   For more details, go to:

  ➡️ emissions-reporting/CARBON_EMISSIONS.md


Contribute to this tutorial

Please refer to these GitHub instructions to open a pull request via the "fork and pull request" workflow.

Pull requests will be reviewed by members of the Climate Change AI Tutorials team for relevance, accuracy, and conciseness.

Climate Change AI Tutorials

Check out the tutorials page on our website for a full list of tutorials demonstrating how AI can be used to tackle problems related to climate change.

License

Usage of this tutorial is subject to the MIT License.

Cite

Plain Text

[Insert plain text citation of accepted submission here.]

BibTeX

[Insert BibTex citation of accepted submission here.]

About

Template repository for CCAI's tutorials track

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages