Installation

Detailed installation and setup instructions for Tiny-DL-Inference.

---

System Requirements

Runtime Requirements

Requirement	Minimum	Recommended
Node.js	18.0	20.x
npm	8.0	10.x
Browser	Chrome 113+ / Edge 113+	Latest

GPU Requirements

WebGPU requires a compatible GPU:

• NVIDIA: GTX 900 series or newer (Driver 470+)
• AMD: RX 400 series or newer
• Intel: Arc series or integrated graphics with latest drivers
• Apple: M1 or newer (macOS Sonoma+)

---

Installation Methods

npm (Recommended)

npm install tiny-dl-inference

yarn

yarn add tiny-dl-inference

pnpm

pnpm add tiny-dl-inference

---

Building from Source

1. Clone the Repository

git clone https://github.com/LessUp/tiny-dl-inference.git
cd tiny-dl-inference

2. Install Dependencies

npm install

3. Build the Project

npm run build

This generates the dist/ directory with:

• ESM module (dist/index.js)
• TypeScript declarations (dist/index.d.ts)
• Source maps for debugging

4. Verify Installation

# Run tests
npm test

# Type checking
npm run typecheck

---

Development Setup

IDE Configuration

VS Code

Recommended extensions:

• TypeScript + JavaScript
• WGSL (WebGPU Shading Language)

Settings (settings.json):

{
  "typescript.preferences.importModuleSpecifier": "relative",
  "editor.formatOnSave": true,
  "[typescript]": {
    "editor.defaultFormatter": "esbenp.prettier-vscode"
  }
}

WebStorm / IntelliJ

Enable TypeScript service and configure the project to use the local TypeScript installation.

---

Browser Setup

Chrome / Edge

WebGPU is enabled by default in Chrome 113+ and Edge 113+.

To verify:

if (navigator.gpu) {
  const adapter = await navigator.gpu.requestAdapter();
  console.log('WebGPU Adapter:', adapter);
}

Safari (Experimental)

WebGPU in Safari requires:

1. macOS Sonoma or later
2. Safari 18+
3. Enable WebGPU in Develop menu

Firefox

WebGPU is behind a flag in Firefox:

1. Navigate to about:config
2. Set dom.webgpu.enabled to true

---

Project Scripts

Script	Description
npm run build	Compile TypeScript to ESM
npm run typecheck	Run TypeScript type checking
npm test	Run test suite
npm run test:watch	Run tests in watch mode
npm run test:coverage	Run tests with coverage report
npm run lint	Run linter
npm run clean	Remove build artifacts

---

Troubleshooting

"Cannot find module 'tiny-dl-inference'"

Ensure the package is installed:

npm ls tiny-dl-inference

TypeScript Errors

Make sure your tsconfig.json includes:

{
  "compilerOptions": {
    "moduleResolution": "bundler",
    "target": "ES2022",
    "module": "ESNext"
  }
}

WebGPU Not Available

1. Update your browser to the latest version
2. Check GPU driver version
3. Try disabling GPU driver sandboxing (Chrome): --disable-gpu-sandbox

---

Next Steps

• Quick Start Guide - Build your first inference
• Architecture - Understand the system design