flow-compute 2.0.0__tar.gz

flow_compute-2.0.0/.cache/uv/.gitignore

@@ -0,0 +1 @@
+*

flow_compute-2.0.0/.cache/uv/CACHEDIR.TAG

@@ -0,0 +1 @@
+Signature: 8a477f597d28d172789f06886806bc55

flow_compute-2.0.0/.claude/settings.local.json

@@ -0,0 +1,16 @@
+{
+  "permissions": {
+    "allow": [
+      "Bash(uv run pytest:*)",
+      "Bash(rg:*)",
+      "Bash(python -m pytest tests/test_basic.py -v)",
+      "Bash(python -m pytest tests/unit/test_volume_commands_comprehensive.py::TestVolumeDeleteCommand -xvs)",
+      "Bash(python -m pytest tests/unit/test_volume_commands_comprehensive.py::TestVolumeDeleteAllCommand -xvs)",
+      "Bash(python -m pytest tests/integration/test_init_e2e.py tests/integration/test_init_reconfigure.py -v)",
+      "Bash(find:*)",
+      "Bash(cp:*)",
+      "Bash(mkdir:*)"
+    ],
+    "deny": []
+  }
+}

flow_compute-2.0.0/.github/workflows/publish.yml

@@ -0,0 +1,59 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      package_name:
+        description: 'Package name to publish'
+        required: true
+        type: choice
+        options:
+          - flow-sdk
+          - mithril-ai
+          - flow-acc
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.11'
+    
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build twine
+    
+    - name: Update package name if needed
+      if: github.event_name == 'workflow_dispatch' && github.event.inputs.package_name != 'flow-sdk'
+      run: |
+        # Backup original
+        cp pyproject.toml pyproject.toml.bak
+        
+        # Update package name
+        sed -i "s/^name = \"flow-sdk\"/name = \"${{ github.event.inputs.package_name }}\"/" pyproject.toml
+        
+        # Show the change
+        echo "Updated package name to: ${{ github.event.inputs.package_name }}"
+        grep "^name = " pyproject.toml
+    
+    - name: Build package
+      run: python -m build
+    
+    - name: Check package
+      run: twine check dist/*
+    
+    - name: Publish to PyPI
+      env:
+        TWINE_USERNAME: __token__
+        TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+      run: |
+        twine upload dist/*
+        echo "Package published to PyPI"
+        echo "Install with: pip install ${{ github.event.inputs.package_name || 'flow-sdk' }}"

flow_compute-2.0.0/.gitignore

@@ -0,0 +1,118 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+eggs/
+sdist/
+*.egg-info/
+.egg/
+dist/
+pip-wheel-metadata/
+
+# Virtual Environments
+env/
+venv/
+ENV/
+.venv/
+
+# IPython/Jupyter
+.ipynb_checkpoints/
+
+# OS files
+.DS_Store
+
+# Pytest cache
+.pytest_cache/
+
+# Ignore generate_catalogue and catalogue_manager
+src/flow/scripts/generate_catalogue.py
+src/flow/managers/catalogue_manager.py
+
+# Ignore log files
+coverage_debug.log
+
+# Ignore packaging metadata
+flow.egg-info/
+
+# Internal documentation
+.internal_documents/
+.internal_docs/
+docs/internal/
+
+# Coverage reports
+.coverage
+.coverage.*
+htmlcov/
+.hypothesis/
+coverage.xml
+*.cover
+
+# Test outputs
+test_report_*.json
+pytest_results.xml
+.tox/
+
+# Temporary files
+tmp/
+temp/
+test-env/
+*.tmp
+*.temp
+
+# Lock files
+uv.lock
+
+# Archive - development history
+.archive/
+
+# API data files
+api_data/
+
+# Development/debug scripts
+gather_api_formats.py
+test_debug.py
+list_available.py
+cleanup_all_resources.py
+cancel_instances.py
+
+# Changelog (for now)
+CHANGELOG.md
+
+# Hidden development directories
+.archive/
+.backup_colab_docs/
+.hypothesis/
+.internal_documents/
+.pytest_cache/
+.ruff_cache/
+.venv/
+
+# Project instructions (private)
+
+# GitBook documentation
+docs/gitbook/
+docs/gitbook-foundry-integration/
+docs/gitbook-*.zip
+docs/*.zip
+
+# Design documents
+docs/bonus/
+docs/*/bonus/
+**/documentation-design.md
+
+# GitBook build artifacts
+_book/
+.gitbook/
+
+# Documentation drafts
+docs/drafts/
+docs/scratch/
+
+# Duplicate/temporary project folders
+flow-sdk-final/
+flow-sdk-*/

flow_compute-2.0.0/COMPREHENSIVE_REVIEW_REPORT.md

@@ -0,0 +1,212 @@
+# Flow SDK Quickstart Review Report
+
+## Executive Summary
+
+This report reviews the proposed quickstart design in `tmp/quickstart-design.md` against the existing Flow SDK documentation, examples, and llms.txt specification. The review identifies key findings and recommendations for alignment.
+
+## Key Findings
+
+### 1. vLLM Inference Examples
+
+**Finding**: The proposed vLLM inference examples are well-structured but need alignment with Flow SDK patterns.
+
+**Issues Identified**:
+- The vLLM example uses `flow.run(config)` returning a server object with `.endpoint` property, but the actual SDK returns a Task object
+- The proposed syntax `server.endpoint` doesn't exist in the current API
+- Port forwarding and endpoint access patterns need clarification
+
+**Recommendations**:
+```python
+# Align with actual Flow SDK patterns
+task = flow.run(config)
+task.wait_for_ready()  # Wait for server to start
+endpoint = task.get_port_forward_url(8000)  # Or similar method
+```
+
+### 2. Instance Type Syntax
+
+**Finding**: The quickstart uses correct instance type syntax that aligns with llms.txt.
+
+**Validated Patterns**:
+- ✅ `"l40s"` - Simple name format (correct)
+- ✅ `"a100_40gb"` - With memory specification (correct)
+- ✅ `"4xa100_40gb"` - Count prefix format (correct)
+- ✅ `"8xa100"` - Multiple GPU format (correct)
+
+**Note**: The llms.txt explicitly states that formats like `"a100x8"` or `"A100"` (uppercase) are NOT supported.
+
+### 3. API Consistency
+
+**Finding**: Several API inconsistencies between quickstart examples and actual SDK.
+
+**Issues**:
+1. **Cost Tracking**: 
+   - Quickstart: `result.estimated_cost`
+   - Actual SDK: Cost tracking not directly exposed on Task object
+
+2. **Output Access**:
+   - Quickstart: `result.output`
+   - Actual SDK: `task.logs()` or streaming logs
+
+3. **Artifact Handling**:
+   - Quickstart: `task.download_artifact()` 
+   - Actual SDK: Need to verify artifact download API
+
+### 4. Configuration Patterns
+
+**Finding**: The TaskConfig usage is mostly correct but some parameters need verification.
+
+**Aligned**:
+- ✅ `command` parameter
+- ✅ `instance_type` parameter
+- ✅ `max_run_time_hours` and `max_run_time_seconds`
+- ✅ `max_price_per_hour`
+- ✅ `ports` parameter
+- ✅ `environment` parameter
+
+**Need Verification**:
+- ❓ `output_artifacts` parameter format
+- ❓ `spot_instance` parameter (vs `spot` or provider-specific)
+
+### 5. CLI Command Mapping
+
+**Finding**: The SLURM → Flow migration commands need validation.
+
+**Proposed Mappings**:
+```bash
+sbatch job.sh              →  flow run job.sh
+squeue                     →  flow list --status running
+scancel <id>               →  flow cancel <id>
+sinfo                      →  flow instances --available
+```
+
+**Note**: Need to verify these CLI commands exist in the actual implementation.
+
+### 6. Code Upload Mechanism
+
+**Finding**: The quickstart examples don't clearly explain the code upload behavior.
+
+**From llms.txt**:
+- FCP provider has a 10KB script limit
+- Code is packaged and uploaded via `_FLOW_CODE_ARCHIVE` environment variable
+- Working directory set to `/workspace` when `upload_code=True`
+
+**Recommendation**: Add explicit documentation about when code upload happens automatically vs when users need to handle it manually.
+
+### 7. Error Handling
+
+**Finding**: The quickstart examples lack error handling patterns.
+
+**Missing**:
+- How to handle `ResourceUnavailableError`
+- How to handle authentication failures
+- How to handle spot instance preemption
+- How to handle quota limits
+
+### 8. Production Patterns
+
+**Strengths**:
+- ✅ Explicit cost controls in every example
+- ✅ Real workloads (not toy examples)
+- ✅ Time estimates for operations
+- ✅ GPU validation before main workload
+
+**Gaps**:
+- Missing checkpoint/resume patterns
+- Missing distributed training setup
+- Missing logging/monitoring integration
+- Missing retry configuration
+
+## Recommendations
+
+### 1. API Alignment
+
+Update all quickstart examples to use actual Flow SDK API:
+
+```python
+# Instead of
+server = flow.run(config)
+print(server.endpoint)
+
+# Use
+task = flow.run(config)
+task.wait()  # or task.wait_for_ready()
+# Document port forwarding approach
+```
+
+### 2. Add Error Handling
+
+Include error handling in every example:
+
+```python
+try:
+    task = flow.run(config)
+except flow.ResourceUnavailableError:
+    print("No instances available. Try different type or increase price limit")
+except flow.AuthenticationError:
+    print("Run 'flow init' to configure API key")
+```
+
+### 3. Document Code Upload
+
+Add explicit section on code upload behavior:
+
+```python
+# When code is uploaded automatically
+config = TaskConfig(
+    command="python train.py",  # Local file triggers upload
+    upload_code=True  # Explicit control
+)
+
+# When using remote scripts only
+config = TaskConfig(
+    shell="curl -s https://example.com/script.sh | bash"
+)
+```
+
+### 4. Clarify Streaming Patterns
+
+Show actual log streaming API:
+
+```python
+task = flow.run(config)
+for line in task.logs(follow=True):
+    print(line, end='')
+```
+
+### 5. Add Monitoring Examples
+
+Include OpenTelemetry integration examples as mentioned in llms.txt.
+
+### 6. Instance Resolution Documentation
+
+Add clear documentation about instance type formats:
+
+```markdown
+## Instance Type Formats
+
+Supported:
+- Simple: "a100", "h100", "l40s"
+- Count prefix: "2xa100", "4xa100", "8xa100"
+- FCP format: "a100-80gb.sxm.1x"
+
+NOT supported:
+- "a100x8" or "a100*8" syntax
+- Uppercase: "A100", "H100"
+- Vendor prefix: "nvidia-a100"
+```
+
+## Conclusion
+
+The quickstart design is well-structured and follows good principles (explicit configuration, cost transparency, production patterns). However, it needs alignment with the actual Flow SDK API and should include more error handling and edge case documentation. The vLLM examples are particularly valuable but need the most work to align with actual SDK capabilities.
+
+## Action Items
+
+1. Verify and update all API calls to match actual SDK
+2. Add comprehensive error handling examples
+3. Document code upload behavior explicitly
+4. Clarify port forwarding and endpoint access patterns
+5. Add instance type format documentation
+6. Include checkpoint/resume examples
+7. Verify CLI command mappings
+8. Add OpenTelemetry monitoring examples

flow_compute-2.0.0/CONTRIBUTING.md

@@ -0,0 +1,47 @@
+# Contributing to Flow SDK
+
+## Development Setup
+
+```bash
+# Clone the repository
+git clone https://github.com/mlfoundry/flow-sdk.git
+cd flow-sdk
+
+# Install dependencies
+uv sync --dev
+
+# Configure API key
+uv run flow init
+
+# Run tests
+uv run pytest
+
+# Run examples
+uv run python examples/01_basics/hello_gpu.py
+```
+
+## Testing
+
+```bash
+# Run all tests
+uv run pytest
+
+# Run specific test file
+uv run pytest tests/unit/test_models.py
+
+# Run with coverage
+uv run pytest --cov=flow
+```
+
+## Code Style
+
+```bash
+# Format code
+uv run black src/flow tests
+
+# Lint
+uv run ruff check src/flow tests
+
+# Type check
+uv run mypy src/flow
+```

flow_compute-2.0.0/LICENSE.txt

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 Foundry Technologies, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.