c3-charm 0.1.0__tar.gz

c3_charm-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+
+                                 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 the 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 the 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 any 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
+
+   Copyright 2025 C3 AI, 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.

c3_charm-0.1.0/PKG-INFO

@@ -0,0 +1,392 @@
+Metadata-Version: 2.3
+Name: c3-charm
+Version: 0.1.0
+Summary: Python SDK for the CHARM time-series foundation model — embeddings, forecasting, and a downstream-task toolkit.
+License: Apache-2.0
+Keywords: time-series,embeddings,forecasting,foundation-model,anomaly-detection
+Author: C3 AI
+Author-email: opensource@c3.ai
+Requires-Python: >=3.10
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+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 :: Scientific/Engineering :: Information Analysis
+Classifier: Typing :: Typed
+Provides-Extra: toolkit
+Requires-Dist: datasetsforecast (>=0.1.0) ; extra == "toolkit"
+Requires-Dist: dill (>=0.3.7) ; extra == "toolkit"
+Requires-Dist: gin-config (>=0.5.0) ; extra == "toolkit"
+Requires-Dist: httpx[http2] (>=0.25.0)
+Requires-Dist: lightgbm (>=4.0.0) ; extra == "toolkit"
+Requires-Dist: matplotlib (>=3.7.0) ; extra == "toolkit"
+Requires-Dist: minisom (>=2.3.1) ; extra == "toolkit"
+Requires-Dist: numpy (>=1.24.0) ; extra == "toolkit"
+Requires-Dist: optuna (>=3.0.0) ; extra == "toolkit"
+Requires-Dist: pandas (>=2.0.0) ; extra == "toolkit"
+Requires-Dist: pyarrow (>=14.0.0) ; extra == "toolkit"
+Requires-Dist: python-dotenv (>=1.0.0)
+Requires-Dist: requests (>=2.31.0)
+Requires-Dist: scienceplots (>=2.0.0) ; extra == "toolkit"
+Requires-Dist: scikit-learn (>=1.3.0) ; extra == "toolkit"
+Requires-Dist: seaborn (>=0.13.0) ; extra == "toolkit"
+Requires-Dist: tensordict (>=0.1.0) ; extra == "toolkit"
+Requires-Dist: torch (>=2.0.0) ; extra == "toolkit"
+Requires-Dist: tqdm (>=4.60.0)
+Project-URL: Documentation, https://github.com/c3ai/c3-charm#readme
+Project-URL: Homepage, https://c3.ai
+Project-URL: Issues, https://github.com/c3ai/c3-charm/issues
+Project-URL: Repository, https://github.com/c3ai/c3-charm
+Description-Content-Type: text/markdown
+
+# c3-charm
+
+[![PyPI version](https://img.shields.io/pypi/v/c3-charm.svg)](https://pypi.org/project/c3-charm/)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/pypi/pyversions/c3-charm.svg)](https://pypi.org/project/c3-charm/)
+
+A Python SDK for interacting with the CHARM time-series API. It provides a simple interface for **embeddings** (multivariate time series → vectors) and **forecast/backcast** (predict future or reconstruct past steps).
+
+## What is CHARM?
+
+CHARM (CHannel Aware Representation Model) is a foundation model specifically designed for multi-variate time series data. It generates high-quality embeddings that capture the semantic essence of time series segments, making them ideal for various downstream applications:
+
+- **Anomaly detection**: Identify unusual patterns in time series data
+- **Clustering**: Group similar time series together
+- **Classification**: Categorize time series into predefined classes
+- **Forecasting**: Improve time series predictions
+- **Similarity search**: Find similar patterns across large datasets
+
+## Data shapes and API reference
+
+Use this section to shape your inputs and interpret outputs. The API has two endpoints; both expect the same **time series format**.
+
+### Shared input format (embeddings and forecast/backcast)
+
+Every request uses:
+
+- **`descriptions`**: List of **channel names** per time series.  
+  - Type: `list[list[str]]`.  
+  - Shape: **(N, C)** — N samples, each with C channel names.  
+  - Example: `[["engine", "temperature"], ["fan", "speed"]]` for N=2, C=2.
+
+- **`ts_array`**: List of **time series values** (one per sample).  
+  - Type: `list[list[list[float]]]`.  
+  - Shape: **(N, T, C)** — N samples, each of T timesteps × C channels.  
+  - **All samples in a single request must have the same T and the same C.**  
+  - Example: one sample with 10 timesteps and 2 channels → a list of 10 rows, each row a list of 2 floats.
+
+**Conventions:**
+
+- **N** = batch size (number of time series in the call).  
+- **T** = timesteps per series (same for all). Must be **≥ 1** and **< 1500** (SDK enforces T < 1500).  
+- **C** = channels per series (same for all). Must be **< 1500**.  
+- **N × C × T ≤ 500,000** per request (client may split into multiple requests via batching).
+
+### 1. Embeddings — `client.embeddings.create` / `client.embeddings.async_create`
+
+**Endpoint:** `POST {base_url}/predict`
+
+| | |
+|--|--|
+| **Input** | `descriptions` (N×C), `ts_array` (N×T×C). See shared format above. |
+| **Output** | `response.embeds`: one vector per time series. Shape **(N, D)** where D = embedding dimension (model-dependent). |
+| **Return type** | `EmbeddingsResponse`: `.embeds`, `.model`, `.usage`, `.raw`. |
+
+Use `return_tensors="list"`, `"np"`, or `"torch"` to get lists, a NumPy array, or a PyTorch tensor.
+
+### 2. Forecast — `client.prediction.create` / `client.prediction.async_create`
+
+**Endpoint:** `POST {base_url}/forecast`
+
+**Input:** Same `descriptions` and `ts_array` as above, plus:
+
+- **`target_len`** (int, required, non-zero):  
+  - **Positive** → forecast that many steps **ahead** (e.g. `10` = next 10 steps).  
+  - **Negative** → backcast that many steps **in the past** (e.g. `-8` = last 8 steps).
+
+| | |
+|--|--|
+| **Output** | `response.denormalized_predictions`: predictions in original scale. Shape **(N, abs(target_len), C, Q)** where Q = number of quantiles (e.g. 21). |
+| **Also** | `response.predictions` (normalized), `response.data` (input echo). Same batch dimension N. |
+| **Return type** | `ForecastResponse`: `.denormalized_predictions`, `.predictions`, `.data`, `.target_len`, `.mode` (`"forecast"` or `"backcast"`), `.raw`. |
+
+Use `return_tensors="list"`, `"np"`, or `"torch"` for all tensor fields.
+
+### Quick reference
+
+| Functionality | Method | Input | Output shape (main) |
+|---------------|--------|--------|---------------------|
+| Embeddings | `embeddings.create` / `async_create` | `descriptions` (N×C), `ts_array` (N×T×C) | **(N, D)** |
+| Forecast | `prediction.create` / `async_create` | Same + `target_len` > 0 | **(N, target_len, C, Q)** |
+| Backcast | `prediction.create` / `async_create` | Same + `target_len` < 0 | **(N, abs(target_len), C, Q)** |
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install c3-charm
+```
+
+To include the downstream-task toolkit (models, trainers, datasets):
+
+```bash
+pip install c3-charm[toolkit]
+```
+
+Or install from source with Poetry:
+
+```bash
+git clone https://github.com/c3ai/c3-charm.git
+cd c3-charm
+poetry install                    # core SDK only
+poetry install --with toolkit     # include toolkit dependencies
+```
+
+## Dependencies
+
+**Core** (installed by default):
+- `requests` — synchronous HTTP client
+- `httpx[http2]` — asynchronous HTTP/2 client
+- `python-dotenv` — `.env` file loading
+- `tqdm` — progress bars
+
+**Toolkit** (optional, `pip install c3-charm[toolkit]`):
+- `torch`, `tensordict` — tensor operations
+- `numpy`, `pandas` — data manipulation
+- `matplotlib`, `seaborn`, `scienceplots` — visualization
+- `scikit-learn` — ML utilities
+- `lightgbm`, `optuna` — gradient boosting & hyperparameter tuning
+- `gin-config` — experiment configuration
+
+## Quick Start
+
+```python
+from charm import CharmClient
+from dotenv import load_dotenv
+import os
+
+# Load environment variables from .env file
+load_dotenv()
+
+# Get API key and base URL from environment variables
+api_key = os.getenv("CHARM_API_KEY", "your-api-key")
+base_url = os.getenv("CHARM_BASE_URL", "http://your-server-url:8080")
+
+# Create a client
+client = CharmClient(
+    base_url=base_url,
+    api_key=api_key,
+    timeout=30,         # Increased timeout for potentially large requests
+    max_retries=3,      # Automatically retry failed requests
+    http2=True,         # Enable HTTP/2 for async requests (default)
+)
+
+# Generate embeddings for time series data (synchronous with progress bar)
+response = client.embeddings.create(
+    descriptions=[["engine", "temperature"], ["fan", "speed"]],
+    ts_array=[
+        # First time series (10 timesteps, 2 channels)
+        [
+            [0.1, 0.2], [0.3, 0.4], [0.5, 0.6], [0.7, 0.8], [0.9, 1.0],
+            [1.1, 1.2], [1.3, 1.4], [1.5, 1.6], [1.7, 1.8], [1.9, 2.0]
+        ],
+        # Second time series (10 timesteps, 2 channels)
+        [
+            [2.1, 2.2], [2.3, 2.4], [2.5, 2.6], [2.7, 2.8], [2.9, 3.0],
+            [3.1, 3.2], [3.3, 3.4], [3.5, 3.6], [3.7, 3.8], [3.9, 4.0]
+        ]
+    ],
+    batch_size=32,      # Process in batches of 32 (for large datasets)
+    return_tensors="np", # Options: "list", "np", "torch"
+    progress=True       # Show progress bar (default: True)
+)
+
+# Access the embeddings
+embeddings = response.embeds
+print(f"Model: {response.model}")
+print(f"Embeddings shape: {embeddings.shape}")
+
+# Asynchronous processing (much faster for large datasets)
+import asyncio
+
+async def generate_embeddings_async():
+    response = await client.embeddings.async_create(
+        descriptions=[["engine", "temperature"], ["fan", "speed"]],
+        ts_array=[
+            # Same time series data as above
+            [
+                [0.1, 0.2], [0.3, 0.4], [0.5, 0.6], [0.7, 0.8], [0.9, 1.0],
+                [1.1, 1.2], [1.3, 1.4], [1.5, 1.6], [1.7, 1.8], [1.9, 2.0]
+            ],
+            [
+                [2.1, 2.2], [2.3, 2.4], [2.5, 2.6], [2.7, 2.8], [2.9, 3.0],
+                [3.1, 3.2], [3.3, 3.4], [3.5, 3.6], [3.7, 3.8], [3.9, 4.0]
+            ]
+        ],
+        max_B_per_request=32,    # Process 32 time series per API call
+        concurrency_per_call=8,  # Run up to 8 concurrent API calls
+        return_tensors="np",     # Options: "list", "np", "torch"
+        progress=True            # Show progress bar (default: True)
+    )
+    return response
+
+# Run the async function
+response_async = asyncio.run(generate_embeddings_async())
+```
+
+### Time Series Forecasting
+
+The CHARM SDK also supports time series forecasting through the `/forecast` endpoint:
+
+```python
+# Forecasting (predict future values)
+response = client.prediction.create(
+    descriptions=[["sensor_A", "sensor_B"]],
+    ts_array=[[
+        [1.0, 2.0],
+        [1.1, 2.1],
+        [1.2, 2.2],
+        [1.3, 2.3],
+        [1.4, 2.4],
+        [1.5, 2.5],
+        [1.6, 2.6],
+        [1.7, 2.7],
+        [1.8, 2.8],
+        [1.9, 2.9],
+    ]],
+    target_len=10,  # Forecast 10 steps ahead
+    return_tensors="np"
+)
+
+# Access the denormalized predictions
+forecast = response.denormalized_predictions
+print(f"Forecast shape: {forecast.shape}")  # e.g., (1, 10, 2, Q) where Q is number of quantiles
+print(f"Mode: {response.mode}")  # "forecast"
+
+# Backcasting (reconstruct past values)
+response = client.prediction.create(
+    descriptions=[["sensor_A", "sensor_B"]],
+    ts_array=[[
+        [1.0, 2.0],
+        [1.1, 2.1],
+        [1.2, 2.2],
+        [1.3, 2.3],
+        [1.4, 2.4],
+        [1.5, 2.5],
+        [1.6, 2.6],
+        [1.7, 2.7],
+        [1.8, 2.8],
+        [1.9, 2.9],
+    ]],
+    target_len=-8,  # Reconstruct last 8 steps
+    return_tensors="np"
+)
+
+reconstructed = response.denormalized_predictions
+print(f"Mode: {response.mode}")  # "backcast"
+```
+
+**Note:** `target_len` is required and must be non-zero:
+- **Positive values**: Forecast future timesteps (e.g., `target_len=10`)
+- **Negative values**: Reconstruct past timesteps (e.g., `target_len=-8`)
+
+### Using a .env file
+
+You can create a `.env` file in your project directory with the following content:
+
+```
+CHARM_API_KEY=your-api-key
+CHARM_BASE_URL=http://your-server-url:8080
+```
+
+This allows you to keep your credentials separate from your code and avoid hardcoding sensitive information.
+
+## Features
+
+- OpenAI-style SDK for CHARM time-series embeddings
+- API key authentication
+- Automatic retries with exponential backoff
+- Configurable timeouts
+- Client-side batching for large datasets
+- Flexible return types (Python lists, NumPy arrays, or PyTorch tensors)
+- Both synchronous and asynchronous methods in a single client:
+  - `client.embeddings.create()` - Synchronous method with progress tracking
+  - `await client.embeddings.async_create()` - Asynchronous method with concurrent batch processing
+  - `client.prediction.create()` - Synchronous prediction method
+  - `await client.prediction.async_create()` - Asynchronous prediction method
+- Progress tracking with tqdm for both sync and async methods
+- HTTP/2 support for asynchronous requests
+- Comprehensive error handling with specific exception types
+- Binary protocol for efficient data transfer (handles raw fp16 bytes from server)
+
+## Performance Considerations
+
+- **Synchronous Method** (`client.embeddings.create`): Suitable for smaller datasets or when simplicity is preferred. Processes batches sequentially, which can be slow for large datasets. Now includes progress tracking with tqdm. Avoid sending very large batches (>100 samples) in a single request to prevent timeouts.
+
+- **Asynchronous Method** (`client.embeddings.async_create`): Recommended for large datasets. Significantly faster due to concurrent processing with features like:
+  - Parallel batch processing
+  - Bounded concurrency to avoid overwhelming the server
+  - Progress tracking for long-running operations
+  - HTTP/2 support for efficient connections
+
+## Payload limitations
+
+The SDK and API enforce:
+
+- **Timesteps per series:** T ≥ 1 and **T < 1500** (enforced by SDK).
+- **Channels per series:** **C < 1500** (see [usage guide](./usage.md)).
+- **Per-request size:** **N × C × T ≤ 500,000** (client-side batching can split larger jobs).
+- **Batch consistency:** All time series in a single request must have the **same T** and the **same C**.
+
+See the [Data shapes and API reference](#data-shapes-and-api-reference) section above for input/output shapes.
+
+## Requirements
+
+- Python 3.10+
+- See [Installation](#installation) for dependency details
+
+## Testing
+
+The CHARM SDK uses pytest for testing. To run the tests:
+
+```bash
+# Install pytest if not already installed
+pip install pytest
+
+# Run all tests
+python -m pytest tests/
+
+# Run specific test file
+python -m pytest tests/test_utils.py
+
+# Run with verbose output
+python -m pytest -v tests/
+```
+
+## Documentation
+
+For detailed documentation, see the [examples](./docs/notebooks) directory, the [usage guide](./usage.md), the [quickstart guide](./quickstart.md), and the docstrings in the code.
+
+## Example Applications
+
+The CHARM SDK can be used for various time series applications:
+
+1. **Anomaly Detection**: Identify unusual patterns in sensor data, network traffic, or financial transactions
+2. **Time Series Clustering**: Group similar time series patterns for market segmentation or behavior analysis
+3. **Classification**: Categorize time series data for predictive maintenance or activity recognition
+4. **Similarity Search**: Find similar patterns across large datasets for pattern discovery
+5. **Forecasting**: Predict future values or reconstruct past values in time series data
+
+Check out the notebooks in the `docs/notebooks` directory for detailed examples of these applications.
+
+## License
+
+This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.
+