{"id":23246251,"url":"https://github.com/subatomicerror/quantum-api","last_synced_at":"2025-08-15T19:19:34.816Z","repository":{"id":266730913,"uuid":"894046231","full_name":"subatomicERROR/Quantum-API","owner":"subatomicERROR","description":"A FastAPI-based service that exposes quantum machine learning capabilities, allowing external applications to interact with quantum models for computation and data analysis.","archived":false,"fork":false,"pushed_at":"2025-08-12T20:48:45.000Z","size":134120,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-12T22:28:36.033Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/subatomicERROR.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE/MIT_LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-11-25T16:50:37.000Z","updated_at":"2025-08-12T20:48:49.000Z","dependencies_parsed_at":"2025-03-07T02:26:56.935Z","dependency_job_id":"7cde67f5-1490-4b6d-82a4-38b4caea2a1f","html_url":"https://github.com/subatomicERROR/Quantum-API","commit_stats":null,"previous_names":["subatomicerror/quantum-api"],"tags_count":0,"template":false,"template_full_name":"github/codespaces-nextjs","purl":"pkg:github/subatomicERROR/Quantum-API","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subatomicERROR%2FQuantum-API","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subatomicERROR%2FQuantum-API/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subatomicERROR%2FQuantum-API/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subatomicERROR%2FQuantum-API/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subatomicERROR","download_url":"https://codeload.github.com/subatomicERROR/Quantum-API/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subatomicERROR%2FQuantum-API/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270617847,"owners_count":24617123,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-15T02:00:12.559Z","response_time":110,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-19T07:13:46.458Z","updated_at":"2025-08-15T19:19:29.782Z","avatar_url":"https://github.com/subatomicERROR.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"---\ntitle: Quantum-API\nemoji: 🚀\ncolorFrom: green\ncolorTo: indigo\nsdk: docker\npython_version: 3.1\nsdk_version: latest\nsuggested_hardware: cpu-basic\nsuggested_storage: small\napp_file: app.py\napp_port: 7860\nbase_path: /\nfullWidth: true\nheader: default\nshort_description: Quantum-AI API for machine learning and quantum computing.\nmodels:\n- openai-community/gpt2\ndatasets:\n- mozilla-foundation/common_voice_13_0\ntags:\n- quantum-ai\n- machine-learning\n- docker\nthumbnail: \u003e-\n  https://cdn-uploads.huggingface.co/production/uploads/66ee940c0989ae1ac1383839/MseLCVmNge3tBJzqDbN1c.jpeg\npinned: true\nhf_oauth: false\ndisable_embedding: false\nstartup_duration_timeout: 30m\ncustom_headers:\n  cross-origin-embedder-policy: require-corp\n  cross-origin-opener-policy: same-origin\n  cross-origin-resource-policy: cross-origin\npreload_from_hub:\n- openai-community/gpt2 config.json\nlicense: mit\n---\n\n# Quantum-API\n\n## Overview\nQuantum-API is a FastAPI-powered Quantum Computing API integrated with PennyLane. It provides a powerful backend for quantum processing while serving a **Gradio** frontend.\n\n## Features\n- **FastAPI Backend**: A lightweight, high-performance API framework.\n- **Quantum Processing**: Handles quantum computations with PennyLane.\n- **Gradio Frontend**: Interactive UI for testing API endpoints.\n- **SEO Optimized**: Metadata for better search engine visibility.\n- **Health Check Endpoint**: Ensures the API is running smoothly.\n\n## Installation\nTo set up and run Quantum-API on your system, follow these steps:\n\n### 1. Clone the Repository\n```bash\ngit clone https://github.com/subatomicERROR/Quantum-API.git\ncd Quantum-API\n```\n\n### 2. Create a Virtual Environment (Optional but Recommended)\n```bash\npython3 -m venv qapi_env\nsource qapi_env/bin/activate  # On Linux/macOS\nqapi_env\\Scripts\\activate  # On Windows\n```\n\n### 3. Install Dependencies\n```bash\npip install -r requirements.txt\n```\n\n### 4. Run the API\n```bash\nuvicorn app:app --host 0.0.0.0 --port 7860 --reload\n```\nThe API will be accessible at: `http://localhost:7860`\n\n## API Endpoints\n\n### Root Endpoint (HTML Response)\n```http\nGET /\n```\nReturns an SEO-optimized HTML welcome page.\n\n### Quantum Processing Endpoint\n```http\nPOST /quantum-endpoint\n```\n**Request Body (JSON):**\n```json\n{\n  \"data\": \"your_data_here\",\n  \"quantum_factor\": 1.0\n}\n```\n**Response (JSON):**\n```json\n{\n  \"status\": \"success\",\n  \"quantum_result\": \"Processed your_data_here with quantum factor 1.0\"\n}\n```\n\n### Health Check\n```http\nGET /health\n```\nReturns the API status.\n\n### OpenAPI Schema\n```http\nGET /openapi.json\n```\nProvides the OpenAPI schema for API documentation.\n\n## Gradio Frontend\n- The **Gradio** frontend provides an interactive UI for testing the API endpoints.\n- Run the Gradio app separately using:\n  ```bash\n  python gradio_ui.py\n  ```\n- Access the Gradio interface at `http://localhost:7860`\n\n## Logging\nLogs are enabled with INFO level logging:\n```bash\n2025-03-27 12:00:00 - INFO - Quantum-API started successfully.\n```\n\n## Deployment\nTo deploy on Hugging Face Spaces:\n1. Ensure all dependencies are listed in `requirements.txt`.\n2. Configure the Hugging Face Space runtime to use `uvicorn app:app --host 0.0.0.0 --port 7860`.\n3. Push the code to your Hugging Face repository.\n\n## Author\nDeveloped by **subatomicERROR** (Yash R).\n\n## 🛠️ Deployment\n- Hosted on Hugging Face Spaces.\n- Built with **Gradio** for UI interaction.\n\n📌 **Created by**: [subatomicERROR](https://github.com/subatomicERROR)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubatomicerror%2Fquantum-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubatomicerror%2Fquantum-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubatomicerror%2Fquantum-api/lists"}