fiddler-evals 0.2.0__tar.gz → 0.2.0rc2__tar.gz

{fiddler_evals-0.2.0/fiddler_evals.egg-info → fiddler_evals-0.2.0rc2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fiddler-evals
-Version: 0.2.0
+Version: 0.2.0rc2
 Summary: Python SDK for evaluating LLM Applications
 Author-email: Fiddler AI <support@fiddler.ai>
 Maintainer-email: Fiddler AI <support@fiddler.ai>
@@ -59,7 +59,7 @@ pip install --upgrade --pre fiddler-evals
 from fiddler_evals import init
 
 # Initialize connection
-init(url='https://your-instance.fiddler.ai', token='your-api-token')
+init(url='https://your-org.fiddler.ai', token='your-api-token')
 ```
 
 ### 2. Create Project Structure

{fiddler_evals-0.2.0 → fiddler_evals-0.2.0rc2}/PUBLIC.md

@@ -38,7 +38,7 @@ pip install --upgrade --pre fiddler-evals
 from fiddler_evals import init
 
 # Initialize connection
-init(url='https://your-instance.fiddler.ai', token='your-api-token')
+init(url='https://your-org.fiddler.ai', token='your-api-token')
 ```
 
 ### 2. Create Project Structure

fiddler_evals-0.2.0rc2/fiddler_evals/VERSION

@@ -0,0 +1 @@
+0.2.0rc2

{fiddler_evals-0.2.0 → fiddler_evals-0.2.0rc2}/fiddler_evals/connection.py

@@ -29,30 +29,63 @@ class Connection:
     managing connection parameters, authentication tokens, and ensuring proper
     communication protocols are established.
 
-    Example:
-        .. code-block:: python
-
-            # Creating a basic connection
-            connection = Connection(
-                url="https://your-instance.fiddler.ai",
-                token="your-auth-token"
-            )
-
-            # Creating a connection with custom timeout and proxy
-            connection = Connection(
-                url="https://your-instance.fiddler.ai",
-                token="your-auth-token",
-                timeout=(5.0, 30.0),  # (connect_timeout, read_timeout)
-                proxies={"https": "https://proxy.company.com:8080"}
-            )
-
-            # Creating a connection without SSL verification
-            connection = Connection(
-                url="https://your-instance.fiddler.ai",
-                token="your-auth-token",
-                verify=False,  # Not recommended for production
-                validate=False  # Skip version compatibility check
-            )
+    Attributes
+    ----------
+    url : str
+        Base URL of the Fiddler platform instance
+    token : str
+        Authentication token for API access
+    proxies : dict, optional
+        Optional proxy configuration for HTTP requests
+    timeout : float or tuple, optional
+        HTTP request timeout settings
+    verify : bool
+        Whether to verify SSL/TLS certificates
+    request_headers : dict
+        HTTP headers including authentication and client info
+    client : RequestClient
+        Cached HTTP client instance for making requests
+    server_info : ServerInfo
+        Cached server information and metadata
+    server_version : VersionInfo
+        Version of the connected Fiddler server
+    organization_name : str
+        Name of the connected organization
+    organization_id : UUID
+        UUID of the connected organization
+
+    Examples
+    --------
+    Creating a basic connection:
+
+    .. code-block:: python
+
+        connection = Connection(
+            url="https://your-fiddler-instance.com",
+            token="your-auth-token"
+        )
+
+    Creating a connection with custom timeout and proxy:
+
+    .. code-block:: python
+
+        connection = Connection(
+            url="https://your-fiddler-instance.com",
+            token="your-auth-token",
+            timeout=(5.0, 30.0),  # (connect_timeout, read_timeout)
+            proxies={"https": "https://proxy.company.com:8080"}
+        )
+
+    Creating a connection without SSL verification:
+
+    .. code-block:: python
+
+        connection = Connection(
+            url="https://your-fiddler-instance.com",
+            token="your-auth-token",
+            verify=False,  # Not recommended for production
+            validate=False  # Skip version compatibility check
+        )
     """
 
     def __init__(  # pylint: disable=too-many-arguments
@@ -66,17 +99,27 @@ class Connection:
     ) -> None:
         """Initialize a connection to the Fiddler platform.
 
-        Args:
-            url: The base URL to your Fiddler platform instance
-            token: Authentication token obtained from the Fiddler UI
-            proxies: Dictionary mapping protocol to proxy URL for HTTP requests
-            timeout: HTTP request timeout settings (float or tuple of connect/read timeouts)
-            verify: Whether to verify server's TLS certificate (default: True)
-            validate: Whether to validate server/client version compatibility (default: True)
-
-        Raises:
-            ValueError: If url or token parameters are empty
-            IncompatibleClient: If server version is incompatible with client version
+        Parameters
+        ----------
+        url : str
+            The base URL to your Fiddler platform instance
+        token : str
+            Authentication token obtained from the Fiddler UI
+        proxies : dict, optional
+            Dictionary mapping protocol to proxy URL for HTTP requests
+        timeout : float or tuple, optional
+            HTTP request timeout settings (float or tuple of connect/read timeouts)
+        verify : bool, default True
+            Whether to verify server's TLS certificate
+        validate : bool, default True
+            Whether to validate server/client version compatibility
+
+        Raises
+        ------
+        ValueError
+            If url or token parameters are empty
+        IncompatibleClient
+            If server version is incompatible with client version
         """
 
         self.url = url
@@ -320,36 +363,30 @@ def init(  # pylint: disable=too-many-arguments
     Examples:
         Basic initialization:
 
-        .. code-block:: python
+        import fiddler as fdl
 
-            import fiddler as fdl
-
-            fdl.init(
-                url="https://your-instance.fiddler.ai",
-                token="your-auth-token"
-            )
+        fdl.init(
+            url="https://your-fiddler-instance.com",
+            token="your-auth-token"
+        )
 
         Initialization with custom timeout and proxy:
 
-        .. code-block:: python
-
-            fdl.init(
-                url="https://your-instance.fiddler.ai",
-                token="your-auth-token",
-                timeout=(10.0, 60.0),  # 10s connect, 60s read timeout
-                proxies={"https": "https://proxy.company.com:8080"}
-            )
+        fdl.init(
+            url="https://your-fiddler-instance.com",
+            token="your-auth-token",
+            timeout=(10.0, 60.0),  # 10s connect, 60s read timeout
+            proxies={"https": "https://proxy.company.com:8080"}
+        )
 
         Initialization for development with relaxed settings:
 
-        .. code-block:: python
-
-            fdl.init(
-                url="https://your-instance.fiddler.ai",
-                token="dev-token",
-                verify=False,  # Skip SSL verification
-                validate=False,  # Skip version compatibility check
-            )
+        fdl.init(
+            url="https://dev-fiddler-instance.com",
+            token="dev-token",
+            verify=False,  # Skip SSL verification
+            validate=False,  # Skip version compatibility check
+        )
 
 
 

{fiddler_evals-0.2.0 → fiddler_evals-0.2.0rc2}/fiddler_evals/entities/application.py

@@ -19,10 +19,8 @@ Common Workflow:
     4. Manage application-level settings and access permissions
 
 Example:
-    .. code-block:: python
-
-        # Create a new application within a project
-        application = Application.create(name="fraud_detection_app", project_id=project_id)
+    # Create a new application within a project
+    application = Application.create(name="fraud_detection_app", project_id=project_id)
 
 Note:
     Application names must be unique within a project. Applications cannot be renamed
@@ -74,12 +72,19 @@ class Application(BaseEntity):
         4. **Maintenance**: Update configurations and resources
         5. **Cleanup**: Delete application when no longer needed
 
-    Example:
-        .. code-block:: python
+    Attributes:
+        id (UUID): Unique application identifier, assigned by server on creation.
+        name (str): Application name, must be unique within the project.
+        created_at (datetime): Application creation timestamp.
+        updated_at (datetime): Last modification timestamp.
+        created_by (UserCompact): User who created the application.
+        updated_by (UserCompact): User who last updated the application.
+        project (ProjectCompact): Project containing this application.
 
-            # Create a new application for fraud detection
-            application = Application.create(name="fraud-detection-app", project_id=project_id)
-            print(f"Created application: {application.name} (ID: {application.id})")
+    Example:
+        # Create a new application for fraud detection
+        application = Application.create(name="fraud-detection-app", project_id=project_id)
+        print(f"Created application: {application.name} (ID: {application.id})")
 
     Note:
         Applications are permanent containers - once created, the name cannot be changed.
@@ -149,13 +154,11 @@ class Application(BaseEntity):
             ApiError: If there's an error communicating with the Fiddler API.
 
         Example:
-            .. code-block:: python
-
-                # Get application by UUID
-                application = Application.get_by_id(id_="550e8400-e29b-41d4-a716-446655440000")
-                print(f"Retrieved application: {application.name}")
-                print(f"Created: {application.created_at}")
-                print(f"Project: {application.project.name}")
+            # Get application by UUID
+            application = Application.get_by_id(id_="550e8400-e29b-41d4-a716-446655440000")
+            print(f"Retrieved application: {application.name}")
+            print(f"Created: {application.created_at}")
+            print(f"Project: {application.project.name}")
 
         Note:
             This method makes an API call to fetch the latest application state from the server.
@@ -187,19 +190,17 @@ class Application(BaseEntity):
             ApiError: If there's an error communicating with the Fiddler API.
 
         Example:
-            .. code-block:: python
-
-                # Get project instance
-                project = Project.get_by_name(name="fraud-detection-project")
+            # Get project instance
+            project = Project.get_by_name(name="fraud-detection-project")
 
-                # Get application by name within a project
-                application = Application.get_by_name(
-                    name="fraud-detection-app",
-                    project_id=project.id
-                )
-                print(f"Found application: {application.name} (ID: {application.id})")
-                print(f"Created: {application.created_at}")
-                print(f"Project: {application.project.name}")
+            # Get application by name within a project
+            application = Application.get_by_name(
+                name="fraud-detection-app",
+                project_id=project.id
+            )
+            print(f"Found application: {application.name} (ID: {application.id})")
+            print(f"Created: {application.created_at}")
+            print(f"Project: {application.project.name}")
 
         Note:
             Application names are case-sensitive and must match exactly. Use this method
@@ -247,27 +248,25 @@ class Application(BaseEntity):
             ApiError: If there's an error communicating with the Fiddler API.
 
         Example:
-            .. code-block:: python
-
-                # Get project instance
-                project = Project.get_by_name(name="fraud-detection-project")
-
-                # List all applications in a project
-                for application in Application.list(project_id=project.id):
-                    print(f"Application: {application.name}")
-                    print(f"  ID: {application.id}")
-                    print(f"  Created: {application.created_at}")
-
-                # Convert to list for counting and filtering
-                applications = list(Application.list(project_id=project.id))
-                print(f"Total applications in project: {len(applications)}")
-
-                # Find applications by name pattern
-                fraud_apps = [
-                    app for app in Application.list(project_id=project.id)
-                    if "fraud" in app.name.lower()
-                ]
-                print(f"Fraud detection applications: {len(fraud_apps)}")
+            # Get project instance
+            project = Project.get_by_name(name="fraud-detection-project")
+
+            # List all applications in a project
+            for application in Application.list(project_id=project.id):
+                print(f"Application: {application.name}")
+                print(f"  ID: {application.id}")
+                print(f"  Created: {application.created_at}")
+
+            # Convert to list for counting and filtering
+            applications = list(Application.list(project_id=project.id))
+            print(f"Total applications in project: {len(applications)}")
+
+            # Find applications by name pattern
+            fraud_apps = [
+                app for app in Application.list(project_id=project.id)
+                if "fraud" in app.name.lower()
+            ]
+            print(f"Fraud detection applications: {len(fraud_apps)}")
 
         Note:
             This method returns an iterator for memory efficiency. Convert to a list
@@ -309,19 +308,17 @@ class Application(BaseEntity):
             ApiError: If there's an error communicating with the Fiddler API.
 
         Example:
-            .. code-block:: python
-
-                # Get project instance
-                project = Project.get_by_name(name="fraud-detection-project")
+            # Get project instance
+            project = Project.get_by_name(name="fraud-detection-project")
 
-                # Create a new application for fraud detection
-                application = Application.create(
-                    name="fraud-detection-app",
-                    project_id=project.id
-                )
-                print(f"Created application with ID: {application.id}")
-                print(f"Created at: {application.created_at}")
-                print(f"Project: {application.project.name}")
+            # Create a new application for fraud detection
+            application = Application.create(
+                name="fraud-detection-app",
+                project_id=project.id
+            )
+            print(f"Created application with ID: {application.id}")
+            print(f"Created at: {application.created_at}")
+            print(f"Project: {application.project.name}")
 
         Note:
             After successful creation, the application instance is returned with
@@ -364,33 +361,31 @@ class Application(BaseEntity):
             ApiError: If there's an error communicating with the Fiddler API.
 
         Example:
-            .. code-block:: python
+            # Get project instance
+            project = Project.get_by_name(name="fraud-detection-project")
 
-                # Get project instance
-                project = Project.get_by_name(name="fraud-detection-project")
+            # Safe application setup - get existing or create new
+            application = Application.get_or_create(
+                name="fraud-detection-app",
+                project_id=project.id
+            )
+            print(f"Using application: {application.name} (ID: {application.id})")
 
-                # Safe application setup - get existing or create new
-                application = Application.get_or_create(
-                    name="fraud-detection-app",
-                    project_id=project.id
-                )
-                print(f"Using application: {application.name} (ID: {application.id})")
+            # Idempotent setup in deployment scripts
+            application = Application.get_or_create(
+                name="llm-pipeline-app",
+                project_id=project.id
+            )
 
-                # Idempotent setup in deployment scripts
-                application = Application.get_or_create(
-                    name="llm-pipeline-app",
+            # Use in configuration management
+            environments = ["dev", "staging", "prod"]
+            applications = {}
+            for env in environments:
+                applications[env] = Application.get_or_create(
+                    name=f"fraud-detection-{env}",
                     project_id=project.id
                 )
 
-                # Use in configuration management
-                environments = ["dev", "staging", "prod"]
-                applications = {}
-                for env in environments:
-                    applications[env] = Application.get_or_create(
-                        name=f"fraud-detection-{env}",
-                        project_id=project.id
-                    )
-
         Note:
             This method is idempotent - calling it multiple times with the same name
             and project_id will return the same application. It logs when creating a new