DLHub-Argonne / DLHub-Argonne/dlhub_examples

Add Example Descriptions

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
Jupyter Notebook
Stars
18
Forks
6
PR merge metrics
No merged PRs in 30d

Description

Add descriptions of examples to the README. Add images of some outputs if they add value

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the README and review the repository's examples to identify what each one demonstrates. Add concise descriptions for the examples and include output images where they add value; the README should clearly explain the examples and show useful results.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.