Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ Thank you for your interest in contributing to AUP Learning Cloud! This document

1. **Clone the repository**
```bash
git clone https://github.com/AMDResearch/aup-learning-cloud-dev.git
cd aup-learning-cloud-dev
git clone https://github.com/AMDResearch/aup-learning-cloud.git
cd aup-learning-cloud
```

2. **Install Python dependencies**
Expand All @@ -26,7 +26,7 @@ Thank you for your interest in contributing to AUP Learning Cloud! This document

3. **Install frontend dependencies**
```bash
cd runtime/admin/frontend/admin-frontend
cd runtime/hub/frontend
pnpm install
cd -
```
Expand Down Expand Up @@ -63,11 +63,11 @@ ruff format .
- **ESLint**: JavaScript/TypeScript/Vue linter
- **Prettier**: Code formatter
- **TypeScript**: Type checking
- **Config**: `runtime/admin/frontend/admin-frontend/eslint.config.js`, `.prettierrc`
- **Config**: `runtime/hub/frontend/eslint.config.js`, `.prettierrc`

Run checks:
```bash
cd runtime/admin/frontend/admin-frontend
cd runtime/hub/frontend

# Lint
pnpm run lint
Expand Down Expand Up @@ -140,7 +140,7 @@ find . -name "*.sh" -o -name "*.bash" | \
# YAML
yamllint .

# Frontend (from runtime/admin/frontend/admin-frontend)
# Frontend (from runtime/hub/frontend)
pnpm run lint
pnpm run format:check
pnpm run type-check
Expand Down Expand Up @@ -196,6 +196,6 @@ Standard production code rules apply to:
## Questions?

- Open an issue for bugs or feature requests
- Check existing documentation in `docs/`
- Check existing documentation at https://amdresearch.github.io/aup-learning-cloud/

Thank you for contributing!
39 changes: 21 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ SOFTWARE.

AUP Learning Cloud is a tailored JupyterHub deployment designed to provide an intuitive and hands-on AI learning experience. It features a comprehensive suite of AI toolkits running on AMD hardware acceleration, enabling users to learn and experiment with ease.

![Software Architecture](docs/imgs/software-stack.png)
![Software Architecture](deploy/docs/images/software-stack.png)


## Quick Start
Expand Down Expand Up @@ -79,9 +79,6 @@ For multi-node cluster installation or need more control over the deployment pro

AUP Learning Cloud offers the following Learning Toolkits:

> [!IMPORTANT]
> Only [**Deep Learning**](projects/DL) and [**Large Language Model from Scratch**](projects/LLM) are available in the v1.0 release.

- [**Computer Vision**](projects/CV) \
Includes 10 hands-on labs covering common computer vision concepts and techniques.

Expand All @@ -91,6 +88,9 @@ Includes 12 hands-on labs covering common deep learning concepts and techniques.
- [**Large Language Model from Scratch**](projects/LLM) \
Includes 9 hands-on labs designed to teach LLM development from scratch.

- [**Physical Simulation**](projects/PhySim) \
Hands-on labs for physics simulation and robotics using Genesis.

## Key Features

### Hardware Acceleration
Expand Down Expand Up @@ -118,27 +118,30 @@ Dynamic NFS provisioning ensures scalable and persistent storage for user data,

## Available Notebook Environments

Current environments are set up as `RESOURCE_IMAGES` in `runtime/chart/files/hub`. These settings should be consistent with `Prepullers` in `runtime/values.yaml`.
Current environments are configured via `custom.resources.images` in `runtime/values.yaml`. These settings should be consistent with `prePuller.extraImages`.

| Environment | Image | Version | Hardware |
| ----------- | ---------------------------------------- | ------- | ------------------------------- |
| Base CPU | `ghcr.io/amdresearch/auplc-default` | v1.0 | CPU |
| CV COURSE | `ghcr.io/amdresearch/auplc-cv` | v1.0 | GPU (Strix-Halo) |
| DL COURSE | `ghcr.io/amdresearch/auplc-dl` | v1.0 | GPU (Strix-Halo) |
| LLM COURSE | `ghcr.io/amdresearch/auplc-llm` | v1.0 | GPU (Strix-Halo) |
| Environment | Image | Hardware |
| ----------- | ---------------------------------------- | ------------------------------- |
| Base CPU | `ghcr.io/amdresearch/auplc-default` | CPU |
| GPU Base | `ghcr.io/amdresearch/auplc-base` | GPU |
| CV COURSE | `ghcr.io/amdresearch/auplc-cv` | GPU |
| DL COURSE | `ghcr.io/amdresearch/auplc-dl` | GPU |
| LLM COURSE | `ghcr.io/amdresearch/auplc-llm` | GPU |
| PhySim COURSE | `ghcr.io/amdresearch/auplc-physim` | GPU |

## Documentation

- [JupyterHub Configuration](docs/jupyterhub/README.md) - Detailed JupyterHub settings
- [Authentication Guide](docs/jupyterhub/authentication-guide.md) - GitHub OAuth and native authentication
- [User Management Guide](docs/jupyterhub/user-management.md) - Batch user operations with scripts
- [User Quota System](docs/jupyterhub/quota-system.md) - Resource usage tracking and quota management
- [GitHub OAuth Setup](docs/jupyterhub/How_to_Setup_GitHub_OAuth.md) - OAuth configuration
- [Maintenance Manual](docs/user-manual/aup-remote-lab-user-manual-admin-new.md) - Operations guide
Full documentation is available at: **https://amdresearch.github.io/aup-learning-cloud/**

- [Deployment Guide](deploy/README.md) - Single-node and multi-node deployment
- [Configuration Reference](https://amdresearch.github.io/aup-learning-cloud/jupyterhub/configuration-reference.html) - `runtime/values.yaml` field reference
- [Authentication Guide](https://amdresearch.github.io/aup-learning-cloud/jupyterhub/authentication-guide.html) - GitHub OAuth and native authentication
- [User Management Guide](https://amdresearch.github.io/aup-learning-cloud/jupyterhub/user-management.html) - Batch user operations with scripts
- [User Quota System](https://amdresearch.github.io/aup-learning-cloud/jupyterhub/quota-system.html) - Resource usage tracking and quota management

## Contributing

Please refer to [CONTRIBUTING.md](docs/contribute.md) for details on how to contribute to the project.
Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for details on how to contribute to the project.

## Acknowledgment

Expand Down
Loading