featrixsphere 0.2.8097__tar.gz → 0.2.8332__tar.gz

featrixsphere-0.2.8332/PKG-INFO

@@ -0,0 +1,442 @@
+Metadata-Version: 2.4
+Name: featrixsphere
+Version: 0.2.8332
+Summary: Transform any CSV into a production-ready ML model in minutes, not months.
+Home-page: https://github.com/Featrix/sphere
+Author: Featrix
+Author-email: support@featrix.com
+Project-URL: Bug Tracker, https://github.com/Featrix/sphere/issues
+Project-URL: Documentation, https://github.com/Featrix/sphere#readme
+Project-URL: Source Code, https://github.com/Featrix/sphere
+Keywords: machine learning,artificial intelligence,neural networks,embedding spaces,prediction,classification,regression,csv,api,client,featrix,sphere,automl,no-code ml
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: HTTP Servers
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.20.0
+Requires-Dist: pandas>=1.0.0
+Provides-Extra: dev
+Requires-Dist: pytest>=6.0; extra == "dev"
+Requires-Dist: pytest-cov>=2.0; extra == "dev"
+Requires-Dist: black>=21.0; extra == "dev"
+Requires-Dist: flake8>=3.8; extra == "dev"
+Requires-Dist: mypy>=0.800; extra == "dev"
+Provides-Extra: progress
+Requires-Dist: rich>=10.0.0; extra == "progress"
+Provides-Extra: notebook
+Requires-Dist: ipython>=7.0.0; extra == "notebook"
+Requires-Dist: ipywidgets>=7.0.0; extra == "notebook"
+Provides-Extra: interactive
+Requires-Dist: ipywidgets>=7.0.0; extra == "interactive"
+Requires-Dist: matplotlib>=3.0.0; extra == "interactive"
+Provides-Extra: server
+Requires-Dist: fastapi>=0.68.0; extra == "server"
+Requires-Dist: uvicorn[standard]>=0.15.0; extra == "server"
+Requires-Dist: celery[redis]>=5.0.0; extra == "server"
+Requires-Dist: redis>=4.0.0; extra == "server"
+Requires-Dist: pydantic-settings>=2.0.0; extra == "server"
+Requires-Dist: python-multipart>=0.0.5; extra == "server"
+Provides-Extra: ml
+Requires-Dist: torch>=1.9.0; extra == "ml"
+Requires-Dist: numpy>=1.21.0; extra == "ml"
+Requires-Dist: scikit-learn>=1.0.0; extra == "ml"
+Requires-Dist: pandas>=1.3.0; extra == "ml"
+Provides-Extra: all
+Requires-Dist: rich>=10.0.0; extra == "all"
+Requires-Dist: ipython>=7.0.0; extra == "all"
+Requires-Dist: ipywidgets>=7.0.0; extra == "all"
+Requires-Dist: fastapi>=0.68.0; extra == "all"
+Requires-Dist: uvicorn[standard]>=0.15.0; extra == "all"
+Requires-Dist: celery[redis]>=5.0.0; extra == "all"
+Requires-Dist: redis>=4.0.0; extra == "all"
+Requires-Dist: pydantic-settings>=2.0.0; extra == "all"
+Requires-Dist: python-multipart>=0.0.5; extra == "all"
+Requires-Dist: torch>=1.9.0; extra == "all"
+Requires-Dist: numpy>=1.21.0; extra == "all"
+Requires-Dist: scikit-learn>=1.0.0; extra == "all"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: project-url
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# 🚀 Featrix Sphere API Client
+
+**Transform any CSV into a production-ready ML model in minutes, not months.**
+
+The Featrix Sphere API automatically builds neural embedding spaces from your data and trains high-accuracy predictors without requiring any ML expertise. Just upload your data, specify what you want to predict, and get a production API endpoint.
+
+## ✨ What Makes This Special?
+
+- 🎯 **99.9%+ Accuracy** - Achieves state-of-the-art results on real-world data
+- ⚡ **Zero ML Knowledge Required** - Upload CSV → Get Production API
+- 🧠 **Neural Embedding Spaces** - Automatically discovers hidden patterns in your data
+- 📊 **Real-time Training Monitoring** - Watch your model train with live loss plots
+- 🔍 **Similarity Search** - Find similar records using vector embeddings
+- 📈 **Beautiful Visualizations** - 2D projections of your high-dimensional data
+- 🚀 **Production Ready** - Scalable batch predictions and real-time inference
+
+## 🎯 Real Results
+
+```python
+# Actual results from fuel card fraud detection:
+prediction = {
+    'True': 0.9999743700027466,    # 99.997% confidence - IS fraud
+    'False': 0.000024269439,       # 0.002% - not fraud
+    '<UNKNOWN>': 0.000001335       # 0.0001% - uncertain
+}
+# Perfect classification with extreme confidence!
+```
+
+## 🚀 Quick Start
+
+### 1. Install & Import
+```bash
+pip install featrixsphere
+```
+
+```python
+from featrixsphere.api import FeatrixSphere
+
+# Initialize client
+featrix = FeatrixSphere("http://your-sphere-server.com")
+```
+
+### 2. Upload Data & Train Model
+```python
+# Option A: Upload CSV file
+fm = featrix.create_foundational_model(
+    name="my_model",
+    data_file="your_data.csv"
+)
+
+# Option B: Upload DataFrame directly (no CSV file needed!)
+import pandas as pd
+df = pd.read_csv("your_data.csv")  # or create/modify DataFrame however you want
+fm = featrix.create_foundational_model(name="my_model", df=df)
+
+# Wait for the embedding space to train
+fm.wait_for_training()
+
+# Create a binary classifier for your target column
+predictor = fm.create_binary_classifier(
+    target_column="is_fraud",
+    name="fraud_detector"
+)
+
+# Wait for predictor training
+predictor.wait_for_training()
+```
+
+### 3. Make Predictions
+```python
+# Single prediction
+result = predictor.predict({
+    "transaction_amount": 1500.00,
+    "merchant_category": "gas_station",
+    "location": "highway_exit"
+})
+
+print(result.predicted_class)  # 'fraud'
+print(result.confidence)       # 0.95
+
+# Batch predictions
+results = predictor.predict_batch([
+    {"amount": 100, "merchant": "grocery"},
+    {"amount": 5000, "merchant": "unknown_vendor"},
+])
+```
+
+## 🎨 Beautiful Examples
+
+### 📊 **DataFrame Upload Workflow**
+```python
+import pandas as pd
+from featrixsphere.api import FeatrixSphere
+
+# Load and prepare your data
+df = pd.read_csv("transactions.csv")
+
+# Optional: Clean/filter/modify your DataFrame
+df = df.dropna()
+df = df[df['amount'] > 0]
+
+# Upload DataFrame directly - no need to save to CSV!
+featrix = FeatrixSphere("https://sphere-api.featrix.com")
+fm = featrix.create_foundational_model(name="transactions", df=df)
+fm.wait_for_training()
+
+# Create predictor
+predictor = fm.create_binary_classifier(
+    target_column="is_fraud",
+    name="fraud_detector"
+)
+predictor.wait_for_training()
+
+# Make predictions
+result = predictor.predict({"amount": 1500, "merchant": "gas_station"})
+print(result.predicted_class)  # 'fraud' or 'legitimate'
+print(result.confidence)       # 0.95
+```
+
+### 🏦 Fraud Detection
+```python
+# Create a binary classifier for fraud detection
+predictor = fm.create_binary_classifier(
+    target_column="is_fraudulent",
+    name="fraud_classifier"
+)
+predictor.wait_for_training()
+
+# Detect fraud in real-time
+result = predictor.predict({
+    "amount": 5000,
+    "merchant": "unknown_vendor",
+    "time": "3:00 AM",
+    "location": "foreign_country"
+})
+print(result.predicted_class)  # 'fraud'
+print(result.confidence)       # 0.98 ⚠️
+```
+
+### 🎯 Customer Segmentation
+```python
+# Create a multiclass classifier
+predictor = fm.create_multi_classifier(
+    target_column="customer_value_segment",  # high/medium/low
+    name="customer_segmentation"
+)
+predictor.wait_for_training()
+
+# Classify new customers
+result = predictor.predict({
+    "age": 34,
+    "income": 75000,
+    "purchase_history": "electronics,books",
+    "engagement_score": 8.5
+})
+print(result.predicted_class)  # 'high_value'
+print(result.probabilities)    # {'high_value': 0.87, 'medium_value': 0.12, 'low_value': 0.01}
+```
+
+### 🏠 Real Estate Pricing
+```python
+# Create a regressor for continuous values
+predictor = fm.create_regressor(
+    target_column="sale_price",
+    name="price_predictor"
+)
+predictor.wait_for_training()
+
+# Get price estimates
+result = predictor.predict({
+    "bedrooms": 4,
+    "bathrooms": 3,
+    "sqft": 2500,
+    "neighborhood": "downtown",
+    "year_built": 2010
+})
+print(result.predicted_value)  # 485000.0 (predicted price: $485,000)
+```
+
+## 🔍 Advanced Features
+
+### Vector Embeddings
+```python
+# Get neural embeddings for any record
+fm = featrix.foundational_model("session-id")
+embedding = fm.encode({
+    "text": "customer complaint about billing",
+    "category": "support",
+    "priority": "high"
+})
+
+print(f"3D embedding: {embedding['embedding_short']}")
+print(f"Full embedding dimension: {len(embedding['embedding_long'])}")
+# Embedding dimension: 512  (rich 512-dimensional representation!)
+```
+
+### Similarity Search
+```python
+# Find similar records using neural embeddings
+similar = fm.similarity_search({
+    "description": "suspicious late night transaction",
+    "amount": 2000
+}, k=10)
+
+print("Similar transactions:")
+for record in similar:
+    print(f"Distance: {record['distance']:.3f} - {record['record']}")
+```
+
+### Working with Existing Models
+```python
+# Load an existing foundational model
+fm = featrix.foundational_model("session-123")
+print(fm.status)  # 'ready'
+
+# List all predictors
+predictors = fm.list_predictors()
+for pred in predictors:
+    print(f"{pred.name}: {pred.target_column} ({pred.accuracy:.2%})")
+
+# Get a specific predictor
+predictor = fm.get_predictor("pred-456")
+result = predictor.predict({"feature": "value"})
+```
+
+### Training Monitoring
+```python
+# Create model with webhooks for notifications
+fm = featrix.create_foundational_model(
+    name="my_model",
+    data_file="data.csv",
+    webhooks={
+        "on_complete": "https://your-server.com/webhook/training-done",
+        "on_error": "https://your-server.com/webhook/training-error"
+    }
+)
+
+# Or poll for status
+while not fm.is_ready():
+    fm.refresh()
+    print(f"Status: {fm.status}")
+    time.sleep(10)
+```
+
+## 📊 API Reference
+
+### Core Classes
+
+| Class | Purpose |
+|-------|---------|
+| `FeatrixSphere` | Main client - connect to API server |
+| `FoundationalModel` | Embedding space - trained on your data |
+| `Predictor` | ML model - makes predictions |
+| `PredictionResult` | Prediction output with confidence |
+
+### FeatrixSphere Methods
+
+| Method | Purpose |
+|--------|---------|
+| `create_foundational_model()` | Upload data & start training |
+| `foundational_model(id)` | Load existing model |
+| `predictor(id, session_id)` | Load existing predictor |
+| `list_sessions()` | List available sessions |
+| `health_check()` | Check API status |
+
+### FoundationalModel Methods
+
+| Method | Purpose |
+|--------|---------|
+| `wait_for_training()` | Wait until training completes |
+| `create_binary_classifier()` | Create 2-class predictor |
+| `create_multi_classifier()` | Create multi-class predictor |
+| `create_regressor()` | Create continuous value predictor |
+| `list_predictors()` | List all predictors |
+| `encode()` | Get neural embedding |
+| `similarity_search()` | Find similar records |
+
+### Predictor Methods
+
+| Method | Purpose |
+|--------|---------|
+| `wait_for_training()` | Wait until training completes |
+| `predict()` | Single record prediction |
+| `predict_batch()` | Multiple record predictions |
+| `get_accuracy()` | Get accuracy metrics |
+
+## 🎯 Pro Tips
+
+### 🚀 Performance Optimization
+```python
+# Use batch predictions for better throughput
+results = predictor.predict_batch(records_list)
+# 10x faster than individual predictions!
+
+# Featrix auto-tunes model parameters for your data
+predictor = fm.create_binary_classifier(
+    target_column="target",
+    name="my_predictor"
+)
+```
+
+### 🎨 Data Preparation
+```python
+# Your CSV just needs:
+# ✅ Clean column names (no spaces/special chars work best)
+# ✅ Target column for prediction
+# ✅ Mix of categorical and numerical features
+# ✅ At least 100+ rows (more = better accuracy)
+
+# The system handles:
+# ✅ Missing values
+# ✅ Mixed data types
+# ✅ Categorical encoding
+# ✅ Feature scaling
+# ✅ Train/validation splits
+```
+
+### 🔍 Debugging & Monitoring
+```python
+# Check model status
+fm = featrix.foundational_model("session-id")
+print(f"Status: {fm.status}")
+
+# Check predictor accuracy
+predictor = fm.get_predictor("pred-id")
+print(f"Accuracy: {predictor.accuracy:.2%}")
+```
+
+## 🏆 Success Stories
+
+> **"We replaced 6 months of ML engineering with 30 minutes of CSV upload. Our fraud detection went from 87% to 99.8% accuracy."**
+> *— FinTech Startup*
+
+> **"The similarity search found patterns in our customer data that our data scientists missed. Revenue up 23%."**
+> *— E-commerce Platform*
+
+> **"Production-ready ML models without hiring a single ML engineer. This is the future."**
+> *— Healthcare Analytics*
+
+## 🎯 Ready to Get Started?
+
+1. **Upload your CSV** - Any tabular data works
+2. **Specify your target** - What do you want to predict?
+3. **Wait for training** - Usually 5-30 minutes depending on data size
+4. **Start predicting** - Get production-ready predictions
+
+```python
+# It's literally this simple:
+from featrixsphere.api import FeatrixSphere
+
+featrix = FeatrixSphere("http://your-server.com")
+fm = featrix.create_foundational_model(name="my_model", data_file="data.csv")
+fm.wait_for_training()
+
+predictor = fm.create_binary_classifier(target_column="target", name="predictor")
+predictor.wait_for_training()
+
+result = predictor.predict(your_record)
+print(f"Prediction: {result.predicted_class} ({result.confidence:.1%})")
+```
+
+**Transform your data into AI. No PhD required.** 🚀

featrixsphere-0.2.8332/VERSION

@@ -0,0 +1 @@
+0.2.8332

featrixsphere-0.2.8332/featrixsphere/__init__.py

@@ -0,0 +1,107 @@
+#  -*- coding: utf-8 -*-
+#
+#  Copyright (c) 2023-2026 Featrix, Inc, All Rights Reserved
+#
+#  Proprietary and Confidential.  Unauthorized use, copying or dissemination
+#  of these materials is strictly prohibited.
+#
+
+"""
+Featrix Sphere API Client
+
+Transform any CSV into a production-ready ML model in minutes, not months.
+
+The Featrix Sphere API automatically builds neural embedding spaces from your data
+and trains high-accuracy predictors without requiring any ML expertise.
+Just upload your data, specify what you want to predict, and get a production API endpoint.
+
+Usage:
+------
+
+    >>> from featrixsphere.api import FeatrixSphere
+    >>>
+    >>> featrix = FeatrixSphere("http://your-server.com")
+    >>>
+    >>> # Create foundational model
+    >>> fm = featrix.create_foundational_model(
+    ...     name="my_model",
+    ...     data_file="data.csv"
+    ... )
+    >>> fm.wait_for_training()
+    >>>
+    >>> # Create predictor
+    >>> predictor = fm.create_binary_classifier(
+    ...     target_column="target",
+    ...     name="my_predictor"
+    ... )
+    >>> predictor.wait_for_training()
+    >>>
+    >>> # Make predictions
+    >>> result = predictor.predict({"feature": "value"})
+    >>> print(result.predicted_class)
+    >>> print(result.confidence)
+
+For more examples, see the documentation at https://docs.featrix.com
+"""
+
+__version__ = "0.2.8332"
+__author__ = "Featrix"
+__email__ = "support@featrix.com"
+__license__ = "MIT"
+
+# New OO API - recommended
+from .api import FeatrixSphere, FoundationalModel, Predictor, PredictionResult
+from .api.exceptions import FeatrixAuthenticationError, FeatrixPredictionError
+from .api.label_utils import find_similar_labels, collapse_similar_labels
+
+__all__ = [
+    "FeatrixAuthenticationError",
+    "FeatrixPredictionError",
+    "FeatrixSphere",
+    "FoundationalModel",
+    "Predictor",
+    "PredictionResult",
+    "find_similar_labels",
+    "collapse_similar_labels",
+    "__version__",
+]
+
+
+# Deprecation shim for old API - prints once and exits
+_deprecated_warning_shown = False
+
+def _show_deprecation_and_exit(name):
+    """Show deprecation warning once and exit."""
+    import sys
+    global _deprecated_warning_shown
+    if _deprecated_warning_shown:
+        sys.exit(1)
+    _deprecated_warning_shown = True
+
+    from pathlib import Path
+    guide_path = Path(__file__).parent / "MIGRATION.md"
+    guide_url = f"file://{guide_path.resolve()}" if guide_path.exists() else "(see featrixsphere docs)"
+
+    print("\n" + "=" * 70, file=sys.stderr)
+    print(f"ERROR: '{name}' has been removed.", file=sys.stderr)
+    print(file=sys.stderr)
+    print("Please upgrade to the new OO API:", file=sys.stderr)
+    print(file=sys.stderr)
+    print("  OLD:  from featrixsphere import FeatrixSphereClient", file=sys.stderr)
+    print("        client = FeatrixSphereClient(url)", file=sys.stderr)
+    print("        session = client.upload_df_and_create_session(df=df)", file=sys.stderr)
+    print(file=sys.stderr)
+    print("  NEW:  from featrixsphere.api import FeatrixSphere", file=sys.stderr)
+    print("        featrix = FeatrixSphere(url)", file=sys.stderr)
+    print("        fm = featrix.create_foundational_model(df=df)", file=sys.stderr)
+    print("        fm.wait_for_training()", file=sys.stderr)
+    print(file=sys.stderr)
+    print(f"Full migration guide: {guide_url}", file=sys.stderr)
+    print("=" * 70 + "\n", file=sys.stderr)
+    sys.exit(1)
+
+def __getattr__(name):
+    """Provide helpful error for deprecated imports."""
+    if name in ("FeatrixSphereClient", "SessionInfo", "PredictionBatch", "PredictionGrid"):
+        _show_deprecation_and_exit(name)
+    raise AttributeError(f"module 'featrixsphere' has no attribute '{name}'")

featrixsphere-0.2.8332/featrixsphere/api/__init__.py

@@ -0,0 +1,75 @@
+#  -*- coding: utf-8 -*-
+#
+#  Copyright (c) 2023-2026 Featrix, Inc, All Rights Reserved
+#
+#  Proprietary and Confidential.  Unauthorized use, copying or dissemination
+#  of these materials is strictly prohibited.
+#
+
+"""
+FeatrixSphere New API
+
+A clean, object-oriented API for interacting with FeatrixSphere.
+
+Usage:
+    from featrixsphere.api import FeatrixSphere
+
+    featrix = FeatrixSphere("https://sphere-api.featrix.com")
+
+    # Create foundational model
+    fm = featrix.create_foundational_model(
+        name="my_model",
+        data_file="data.csv"
+    )
+    fm.wait_for_training()
+
+    # Create a binary classifier
+    predictor = fm.create_binary_classifier(
+        target_column="target",
+        name="my_classifier"
+    )
+    predictor.wait_for_training()
+
+    # Or a multiclass classifier
+    predictor = fm.create_multi_classifier(
+        target_column="category",
+        name="my_multiclass"
+    )
+    predictor.wait_for_training()
+
+    # Make predictions
+    result = predictor.predict({"feature1": "value1"})
+    print(result.predicted_class)
+    print(result.confidence)
+"""
+
+from .exceptions import FeatrixAuthenticationError, FeatrixPredictionError
+from .client import FeatrixSphere
+from .foundational_model import FoundationalModel
+from .predictor import Predictor
+from .published_predictor import PublishedPredictor
+from .prediction_result import PredictionResult, PredictionFeedback
+from .prediction_grid import PredictionGrid
+from .vector_database import VectorDatabase
+from .reference_record import ReferenceRecord
+from .api_endpoint import APIEndpoint
+from .notebook_helper import FeatrixNotebookHelper
+from .label_utils import find_similar_labels, collapse_similar_labels
+
+__all__ = [
+    'FeatrixAuthenticationError',
+    'FeatrixPredictionError',
+    'FeatrixSphere',
+    'FoundationalModel',
+    'Predictor',
+    'PublishedPredictor',
+    'PredictionResult',
+    'PredictionFeedback',
+    'PredictionGrid',
+    'VectorDatabase',
+    'ReferenceRecord',
+    'APIEndpoint',
+    'FeatrixNotebookHelper',
+    'find_similar_labels',
+    'collapse_similar_labels',
+]