docs: restructure website, optimize HTML, gitignore private files
Website docs (website/docs/): - Delete 6 stale -md.html duplicates - Rename docs-clients/miners/developers → clients/miners/developers.html - Unify header/nav across all 15 pages (new .site-header pattern) - Fix 34 dead href=# links with real targets - Upgrade Font Awesome v4→v6 in index.html - Replace search stub with live client-side search (15-page index) - Extract all inline CSS into shared docs.css (+630 lines) - Extract inline theme JS into shared theme.js - Strip inline style= attributes from 10+ pages - Add .announce-banner, .source-links, .search-results CSS classes - Add Markdown Source links to clients/miners/developers pages - Update components.html title to Architecture & Components - Move browser-wallet.html to website/wallet/, leave redirect - Update all dates to February 2026 Website root: - Delete 6 root-level duplicate HTML files (160KB saved) - Rewire index.html and 404.html links Root README.md: - Fix 8 broken doc links to new numbered folder structure - Update copyright to 2026 .gitignore + .example files: - Gitignore private files: .aitbc.yaml, .env, deploy scripts, GPU scripts, service scripts, infra configs, .windsurf/, website README - Create 7 .example files for GitHub users with sanitized templates - Untrack 47 previously committed private files Live server: - Push all website files to aitbc-cascade:/var/www/html/ - Clean stale admin.html and index.nginx-debian.html
This commit is contained in:
oib
459
website/docs/clients.html
Normal file
459
website/docs/clients.html
Normal file
@@ -0,0 +1,459 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="UTF-8">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
||||
<title>Client Documentation - AITBC</title>
|
||||
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/all.min.css">
|
||||
<link rel="stylesheet" href="css/docs.css">
|
||||
</head>
|
||||
<body>
|
||||
<!-- Header -->
|
||||
<header class="site-header">
|
||||
<div class="container">
|
||||
<div class="header-inner">
|
||||
<a href="/" class="brand">
|
||||
<i class="fas fa-cube"></i>
|
||||
<span>AITBC</span>
|
||||
</a>
|
||||
<nav class="header-nav">
|
||||
<a href="/">Home</a>
|
||||
<a href="/explorer/">Explorer</a>
|
||||
<a href="/Exchange/">Exchange</a>
|
||||
<a href="/docs/index.html" class="active">Docs</a>
|
||||
<button id="theme-toggle" class="theme-toggle" title="Toggle theme"><i class="fas fa-sun"></i></button>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
|
||||
<!-- Main Content -->
|
||||
<main>
|
||||
<div class="container">
|
||||
<div class="doc-header">
|
||||
<span class="audience-badge">For Clients</span>
|
||||
<h1>Use AITBC for AI/ML Workloads</h1>
|
||||
<p>Access secure, private, and verifiable AI/ML computation on the decentralized network</p>
|
||||
<div class="source-links">
|
||||
<a href="https://github.com/oib/AITBC/tree/main/docs/2_clients" target="_blank"><i class="fas fa-file-alt"></i> Markdown Source: docs/2_clients/</a>
|
||||
</div>
|
||||
<div class="announce-banner green">
|
||||
<h3>✅ Now Available: Full CLI with 90+ Commands</h3>
|
||||
<p>Submit jobs, track lifecycle, manage wallet, and verify receipts. Supporting 13+ Ollama models with real-time blockchain verification!</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Key Features -->
|
||||
<div class="feature-grid">
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">
|
||||
<i class="fas fa-shield-alt"></i>
|
||||
</div>
|
||||
<h3>Privacy First</h3>
|
||||
<p>Your data and models remain confidential with zero-knowledge proofs and secure enclaves</p>
|
||||
</div>
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">
|
||||
<i class="fas fa-check-circle"></i>
|
||||
</div>
|
||||
<h3>Verifiable Results</h3>
|
||||
<p>Every computation is cryptographically verified on the blockchain for trust and transparency</p>
|
||||
</div>
|
||||
<div class="feature-card">
|
||||
<div class="feature-icon">
|
||||
<i class="fas fa-bolt"></i>
|
||||
</div>
|
||||
<h3>Fast & Efficient</h3>
|
||||
<p>Access thousands of GPUs worldwide with sub-second response times</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Getting Started -->
|
||||
<section class="content-section">
|
||||
<div class="alert alert-info">
|
||||
<i class="fas fa-info-circle"></i>
|
||||
<strong>System Flow:</strong> See the <a href="flowchart.html">complete system flow diagram</a> to understand how client requests flow through the AITBC system.
|
||||
</div>
|
||||
|
||||
<h2>Getting Started</h2>
|
||||
<p>Start using AITBC in minutes with our simple client SDK or web interface.</p>
|
||||
|
||||
<h3>Quick Start Options</h3>
|
||||
<ul>
|
||||
<li><strong>CLI Wrapper Tool</strong>: ✅ NEW - Unified bash script for job management</li>
|
||||
<li><strong>Web Interface</strong>: No installation required</li>
|
||||
<li><strong>Python SDK</strong>: For AI/ML developers</li>
|
||||
<li><strong>JavaScript SDK</strong>: For web applications</li>
|
||||
<li><strong>REST API</strong>: For any platform</li>
|
||||
</ul>
|
||||
|
||||
<h3>CLI Wrapper Tool (Recommended)</h3>
|
||||
<div class="step">
|
||||
<div class="step-number">1</div>
|
||||
<div class="step-content">
|
||||
<h4>Submit an Inference Job</h4>
|
||||
<p>Use the bash CLI wrapper for easy job submission</p>
|
||||
<div class="code-block">
|
||||
# Submit job with CLI wrapper
|
||||
./scripts/aitbc-cli.sh submit inference \
|
||||
--prompt "What is machine learning?" \
|
||||
--model llama3.2:latest
|
||||
|
||||
# Check job status
|
||||
./scripts/aitbc-cli.sh status <job_id>
|
||||
|
||||
# View receipt with payment details
|
||||
./scripts/aitbc-cli.sh receipts --job-id <job_id></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Available Models:</strong> llama3.2, mistral, deepseek-r1:14b, gemma3, qwen2.5-coder, and 8+ more via Ollama integration. Processing time: 11-25 seconds. Rate: 0.02 AITBC per GPU second.
|
||||
</div>
|
||||
|
||||
<h3>Web Interface (Fastest)</h3>
|
||||
<div class="step">
|
||||
<div class="step-number">1</div>
|
||||
<div class="step-content">
|
||||
<h4>Visit the Marketplace</h4>
|
||||
<p>Go to <a href="https://aitbc.bubuit.net/marketplace">aitbc.bubuit.net/marketplace</a></p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="step">
|
||||
<div class="step-number">2</div>
|
||||
<div class="step-content">
|
||||
<h4>Connect Your Wallet</h4>
|
||||
<p>Connect MetaMask or create a new AITBC wallet</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="step">
|
||||
<div class="step-number">3</div>
|
||||
<div class="step-content">
|
||||
<h4>Submit Your Job</h4>
|
||||
<p>Upload your data or model, select parameters, and submit</p>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="step">
|
||||
<div class="step-number">4</div>
|
||||
<div class="step-content">
|
||||
<h4>Get Results</h4>
|
||||
<p>Receive verified results with cryptographic proof</p>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Use Cases -->
|
||||
<section class="content-section">
|
||||
<h2>Popular Use Cases</h2>
|
||||
|
||||
<div class="use-case-grid">
|
||||
<div class="use-case-card">
|
||||
<h4><i class="fas fa-brain"></i> AI Inference ✅ LIVE</h4>
|
||||
<p>Run inference on pre-trained models including LLama, Mistral, DeepSeek, and custom models via Ollama</p>
|
||||
<ul>
|
||||
<li>Text generation (13+ models)</li>
|
||||
<li>Code generation (DeepSeek, Qwen)</li>
|
||||
<li>Translation (Qwen2.5-translator)</li>
|
||||
<li>Real-time processing (11-25s)</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="use-case-card">
|
||||
<h4><i class="fas fa-graduation-cap"></i> Model Training</h4>
|
||||
<p>Train and fine-tune models on your data with privacy guarantees</p>
|
||||
<ul>
|
||||
<li>Fine-tuning LLMs</li>
|
||||
<li>Custom model training</li>
|
||||
<li>Federated learning</li>
|
||||
<li>Transfer learning</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="use-case-card">
|
||||
<h4><i class="fas fa-chart-line"></i> Data Analysis</h4>
|
||||
<p>Process large datasets with confidential computing</p>
|
||||
<ul>
|
||||
<li>Statistical analysis</li>
|
||||
<li>Pattern recognition</li>
|
||||
<li>Predictive modeling</li>
|
||||
<li>Data visualization</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
<div class="use-case-card">
|
||||
<h4><i class="fas fa-lock"></i> Secure Computation</h4>
|
||||
<p>Run sensitive computations with end-to-end encryption</p>
|
||||
<ul>
|
||||
<li>Financial modeling</li>
|
||||
<li>Healthcare analytics</li>
|
||||
<li>Legal document processing</li>
|
||||
<li>Proprietary algorithms</li>
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- SDK Examples -->
|
||||
<section class="content-section">
|
||||
<h2>SDK Examples</h2>
|
||||
|
||||
<h3>Python SDK</h3>
|
||||
<div class="code-block">
|
||||
# Install the SDK
|
||||
pip install aitbc
|
||||
|
||||
# Initialize client
|
||||
from aitbc import AITBCClient
|
||||
|
||||
client = AITBCClient(api_key="your-api-key")
|
||||
|
||||
# Run inference
|
||||
result = client.inference(
|
||||
model="gpt-4",
|
||||
prompt="Explain quantum computing",
|
||||
max_tokens=500,
|
||||
temperature=0.7
|
||||
)
|
||||
|
||||
print(result.text)
|
||||
|
||||
# Verify the receipt
|
||||
is_valid = client.verify_receipt(result.receipt_id)
|
||||
print(f"Verified: {is_valid}")</div>
|
||||
|
||||
<h3>JavaScript SDK</h3>
|
||||
<div class="code-block">
|
||||
// Install the SDK
|
||||
npm install @aitbc/client
|
||||
|
||||
// Initialize client
|
||||
import { AITBCClient } from '@aitbc/client';
|
||||
|
||||
const client = new AITBCClient({
|
||||
apiKey: 'your-api-key',
|
||||
network: 'mainnet'
|
||||
});
|
||||
|
||||
// Run inference
|
||||
const result = await client.inference({
|
||||
model: 'stable-diffusion',
|
||||
prompt: 'A futuristic city',
|
||||
steps: 50,
|
||||
cfg_scale: 7.5
|
||||
});
|
||||
|
||||
// Download the image
|
||||
await client.downloadImage(result.imageId, './output.png');
|
||||
|
||||
// Verify computation
|
||||
const verified = await client.verify(result.receiptId);
|
||||
console.log('Computation verified:', verified);</div>
|
||||
|
||||
<h3>REST API</h3>
|
||||
<div class="code-block">
|
||||
# Submit a job
|
||||
curl -X POST https://aitbc.bubuit.net/api/v1/jobs \
|
||||
-H "Authorization: Bearer YOUR_TOKEN" \
|
||||
-H "Content-Type: application/json" \
|
||||
-d '{
|
||||
"type": "inference",
|
||||
"model": "gpt-4",
|
||||
"input": {
|
||||
"prompt": "Hello, AITBC!",
|
||||
"max_tokens": 100
|
||||
},
|
||||
"privacy": {
|
||||
"confidential": true,
|
||||
"zk_proof": true
|
||||
}
|
||||
}'
|
||||
|
||||
# Check job status
|
||||
curl -X GET https://aitbc.bubuit.net/api/v1/jobs/JOB_ID \
|
||||
-H "Authorization: Bearer YOUR_TOKEN"</div>
|
||||
</section>
|
||||
|
||||
<!-- Pricing -->
|
||||
<section class="content-section">
|
||||
<h2>Pricing</h2>
|
||||
<p>Flexible pricing options for every use case</p>
|
||||
|
||||
<div class="pricing-table">
|
||||
<div class="pricing-card">
|
||||
<h3>Pay-per-use</h3>
|
||||
<div class="price">$0.01<span class="price-unit">/1K tokens</span></div>
|
||||
<ul>
|
||||
<li>No minimum commitment</li>
|
||||
<li>Pay only for what you use</li>
|
||||
<li>All models available</li>
|
||||
<li>Basic support</li>
|
||||
</ul>
|
||||
<button class="btn btn-outline">Get Started</button>
|
||||
</div>
|
||||
|
||||
<div class="pricing-card featured">
|
||||
<h3>Professional</h3>
|
||||
<div class="price">$99<span class="price-unit">/month</span></div>
|
||||
<ul>
|
||||
<li>$500 included credits</li>
|
||||
<li>Priority processing</li>
|
||||
<li>Advanced models</li>
|
||||
<li>Email support</li>
|
||||
<li>API access</li>
|
||||
</ul>
|
||||
<button class="btn">Start Free Trial</button>
|
||||
</div>
|
||||
|
||||
<div class="pricing-card">
|
||||
<h3>Enterprise</h3>
|
||||
<div class="price">Custom</div>
|
||||
<ul>
|
||||
<li>Unlimited usage</li>
|
||||
<li>Dedicated resources</li>
|
||||
<li>Custom models</li>
|
||||
<li>24/7 support</li>
|
||||
<li>SLA guarantee</li>
|
||||
</ul>
|
||||
<button class="btn btn-outline">Contact Sales</button>
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
|
||||
<!-- Privacy & Security -->
|
||||
<section class="content-section">
|
||||
<h2>Privacy & Security</h2>
|
||||
|
||||
<div class="alert alert-success">
|
||||
<strong>Your data is never stored or exposed</strong> - All computations are performed in secure enclaves with zero-knowledge proof verification.
|
||||
</div>
|
||||
|
||||
<h3>Privacy Features</h3>
|
||||
<ul>
|
||||
<li><strong>End-to-end encryption</strong> - Your data is encrypted before leaving your device</li>
|
||||
<li><strong>Zero-knowledge proofs</strong> - Prove computation without revealing inputs</li>
|
||||
<li><strong>Secure enclaves</strong> - Computations run in isolated, verified environments</li>
|
||||
<li><strong>No data retention</strong> - Providers cannot access or store your data</li>
|
||||
<li><strong>Audit trails</strong> - Full transparency on blockchain</li>
|
||||
</ul>
|
||||
|
||||
<h3>Compliance</h3>
|
||||
<ul>
|
||||
<li>GDPR compliant</li>
|
||||
<li>SOC 2 Type II certified</li>
|
||||
<li>HIPAA eligible</li>
|
||||
<li>ISO 27001 certified</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<!-- Best Practices -->
|
||||
<section class="content-section">
|
||||
<h2>Best Practices</h2>
|
||||
|
||||
<h3>Optimizing Performance</h3>
|
||||
<ul>
|
||||
<li>Use appropriate model sizes for your task</li>
|
||||
<li>Batch requests when possible</li>
|
||||
<li>Enable caching for repeated queries</li>
|
||||
<li>Choose the right privacy level for your needs</li>
|
||||
<li>Monitor your usage and costs</li>
|
||||
</ul>
|
||||
|
||||
<h3>Security Tips</h3>
|
||||
<ul>
|
||||
<li>Keep your API keys secure</li>
|
||||
<li>Use environment variables for credentials</li>
|
||||
<li>Enable two-factor authentication</li>
|
||||
<li>Regularly rotate your keys</li>
|
||||
<li>Use VPN for additional privacy</li>
|
||||
</ul>
|
||||
|
||||
<h3>Cost Optimization</h3>
|
||||
<ul>
|
||||
<li>Start with smaller models for testing</li>
|
||||
<li>Use streaming for long responses</li>
|
||||
<li>Set appropriate limits and timeouts</li>
|
||||
<li>Monitor token usage</li>
|
||||
<li>Consider subscription plans for regular use</li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<!-- Support -->
|
||||
<section class="content-section">
|
||||
<h2>Support & Resources</h2>
|
||||
|
||||
<h3>Getting Help</h3>
|
||||
<ul>
|
||||
<li><strong>Documentation</strong>: <a href="full-documentation.html">Full API reference</a></li>
|
||||
<li><strong>Community</strong>: <a href="https://discord.gg/aitbc">Join our Discord</a></li>
|
||||
<li><strong>Email</strong>: <a href="mailto:aitbc@bubuit.net">aitbc@bubuit.net</a></li>
|
||||
<li><strong>Status</strong>: <a href="https://status.aitbc.bubuit.net">System status</a></li>
|
||||
</ul>
|
||||
|
||||
<h3>Tutorials</h3>
|
||||
<ul>
|
||||
<li><a href="miners.html">Getting Started with AI Inference</a></li>
|
||||
<li><a href="https://github.com/oib/AITBC/tree/main/docs/8_development/4_examples.md" target="_blank">Building a Chat Application</a></li>
|
||||
<li><a href="https://github.com/oib/AITBC/tree/main/docs/8_development/4_examples.md" target="_blank">Image Generation Guide</a></li>
|
||||
<li><a href="full-documentation.html#security">Privacy-Preserving ML</a></li>
|
||||
<li><a href="api.html">API Integration Best Practices</a></li>
|
||||
</ul>
|
||||
|
||||
<h3>Examples</h3>
|
||||
<ul>
|
||||
<li><a href="https://github.com/oib/AITBC" target="_blank">GitHub Repository</a></li>
|
||||
<li><a href="https://github.com/oib/AITBC/tree/main/docs/8_development/4_examples.md" target="_blank">Code Examples</a></li>
|
||||
<li><a href="https://github.com/oib/AITBC/tree/main/docs/8_development" target="_blank">Sample Applications</a></li>
|
||||
<li><a href="developers.html">SDK Documentation</a></li>
|
||||
</ul>
|
||||
</section>
|
||||
|
||||
<!-- FAQ -->
|
||||
<section class="content-section">
|
||||
<h2>Frequently Asked Questions</h2>
|
||||
|
||||
<div class="alert alert-info">
|
||||
<strong>Question not answered?</strong> Contact us at <a href="mailto:aitbc@bubuit.net">aitbc@bubuit.net</a>
|
||||
</div>
|
||||
|
||||
<h3>General</h3>
|
||||
<ul>
|
||||
<li><strong>How do I get started?</strong> - Sign up for an account, connect your wallet, and submit your first job through the web interface or API.</li>
|
||||
<li><strong>What models are available?</strong> - We support GPT-3.5/4, Claude, Llama, Stable Diffusion, and many custom models.</li>
|
||||
<li><strong>Can I use my own model?</strong> - Yes, you can upload and run private models with full confidentiality.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Privacy</h3>
|
||||
<ul>
|
||||
<li><strong>Is my data private?</strong> - Absolutely. Your data is encrypted and never exposed to providers.</li>
|
||||
<li><strong>How do ZK proofs work?</strong> - They prove computation was done correctly without revealing inputs.</li>
|
||||
<li><strong>Can you see my prompts?</strong> - No, prompts are encrypted and processed in secure enclaves.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Technical</h3>
|
||||
<ul>
|
||||
<li><strong>What's the response time?</strong> - Most jobs complete in 1-5 seconds depending on complexity.</li>
|
||||
<li><strong>Do you support streaming?</strong> - Yes, streaming is available for real-time applications.</li>
|
||||
<li><strong>Can I run batch jobs?</strong> - Yes, batch processing is supported for large workloads.</li>
|
||||
</ul>
|
||||
|
||||
<h3>Billing</h3>
|
||||
<ul>
|
||||
<li><strong>How am I billed?</strong> - Pay-per-use or monthly subscription options available.</li>
|
||||
<li><strong>Can I set spending limits?</strong> - Yes, you can set daily/monthly limits in your dashboard.</li>
|
||||
<li><strong>Do you offer refunds?</strong> - Yes, we offer refunds for service issues within 30 days.</li>
|
||||
</ul>
|
||||
</section>
|
||||
</div>
|
||||
</main>
|
||||
|
||||
<!-- Footer -->
|
||||
<footer>
|
||||
<div class="container">
|
||||
<p>© 2026 AITBC. All rights reserved.</p>
|
||||
</div>
|
||||
</footer> <script src="js/theme.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user