LRLearning RoadmapRead, build, evaluate
Templates

Project Name

Project Name One paragraph description of what this project does and what skill it demonstrates. Problem What problem does this solve? Goals Goal 1 Goal 2 Goal 3 Non Goals What is

templates/project-readme-template.md1 min read

Project Name

One-paragraph description of what this project does and what skill it demonstrates.

Problem

What problem does this solve?

Goals

  • Goal 1
  • Goal 2
  • Goal 3

Non-Goals

  • What is intentionally out of scope?

Architecture

User -> API -> Service -> Data Store -> AI Component -> Response

Tech Stack

  • Language:
  • Framework:
  • Database:
  • AI model/provider:
  • Deployment:

Setup

# Add setup commands here

Evaluation

  • Dataset:
  • Metrics:
  • Baseline:
  • Result:
  • Known limitations:

Security

  • Authentication:
  • Authorization:
  • Secrets:
  • Audit:
  • Data handling:

Trade-Offs

  • Decision:
  • Alternatives:
  • Why this choice:
  • Consequences:

Demo

  • Scenario 1:
  • Scenario 2:
  • Scenario 3:

Next Improvements

  • Improvement 1
  • Improvement 2