synkro 0.4.12__py3-none-any.whl

synkro-0.4.12.dist-info/METADATA

@@ -0,0 +1,258 @@
+Metadata-Version: 2.4
+Name: synkro
+Version: 0.4.12
+Summary: Generate training datasets from any document
+Author: Murtaza Meerza
+License-Expression: MIT
+License-File: LICENSE
+Keywords: dataset-generation,fine-tuning,llm,synthetic-data,training-data
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT 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
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.12
+Requires-Dist: html2text>=2020.1
+Requires-Dist: httpx>=0.25
+Requires-Dist: litellm>=1.40
+Requires-Dist: mammoth>=1.6
+Requires-Dist: marker-pdf>=0.2
+Requires-Dist: pydantic>=2.0
+Requires-Dist: python-dotenv>=1.0
+Requires-Dist: rich>=13.0
+Requires-Dist: typer>=0.9
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Synkro
+
+Turn policies, handbooks, and documentation into high-quality training data for fine-tuning LLMs.
+
+## Features
+
+- **Quality Evaluation** - Each response is graded and automatically refined if it fails
+- **Multiple Formats** - SFT (chat), QA (question-answer), and Tool Calling
+- **Tool Call Training** - Generate OpenAI function calling format for teaching models to use custom tools
+- **Top LLM Providers** - OpenAI, Anthropic, and Google
+- **File Support** - PDF, DOCX, TXT, Markdown, URLs
+- **CLI Included** - Generate datasets from the command line
+
+## Installation
+
+```bash
+pip install synkro
+```
+
+## Quick Start
+
+```python
+from synkro.pipelines import create_pipeline
+from synkro.models.google import Google
+from synkro.types import DatasetType
+
+pipeline = create_pipeline(
+    model=Google.GEMINI_25_FLASH,          # Fast generation
+    grading_model=Google.GEMINI_25_PRO,    # Quality grading
+    dataset_type=DatasetType.SFT,
+)
+
+dataset = pipeline.generate(
+    "All expenses over $50 require manager approval.",
+    traces=50,
+)
+dataset.save("training.jsonl")
+```
+
+### From Files
+
+```python
+from synkro.pipelines import create_pipeline
+from synkro.core.policy import Policy
+
+policy = Policy.from_file("handbook.pdf")  # PDF, DOCX, TXT, MD
+pipeline = create_pipeline()
+dataset = pipeline.generate(policy, traces=100)
+dataset.save()
+```
+
+### From URLs
+
+```python
+from synkro.core.policy import Policy
+
+policy = Policy.from_url("https://example.com/terms")
+dataset = pipeline.generate(policy)
+```
+
+## Dataset Types
+
+| Format | Output | Best For |
+|--------|--------|----------|
+| **SFT** | Chat messages | Fine-tuning chat models |
+| **QA** | Question-answer pairs | RAG systems, knowledge bases |
+| **TOOL_CALL** | Function calling format | Training models to use custom tools |
+
+### SFT (Default)
+
+```python
+from synkro.types import DatasetType
+
+pipeline = create_pipeline(dataset_type=DatasetType.SFT)
+dataset = pipeline.generate(policy)
+```
+
+Output:
+```json
+{"messages": [
+  {"role": "system", "content": "You are a policy expert..."},
+  {"role": "user", "content": "What's the approval process for $350?"},
+  {"role": "assistant", "content": "For a $350 expense, you need..."}
+]}
+```
+
+### QA
+
+```python
+pipeline = create_pipeline(dataset_type=DatasetType.QA)
+```
+
+Output:
+```json
+{"question": "What's the approval process?", "answer": "You need...", "context": "..."}
+```
+
+### Tool Calling
+
+Generate training data for teaching models when and how to use your custom tools:
+
+```python
+from synkro import create_pipeline, ToolDefinition, DatasetType
+
+# Define your tools
+web_search = ToolDefinition(
+    name="web_search",
+    description="Search the web for current information",
+    parameters={
+        "type": "object",
+        "properties": {
+            "query": {"type": "string", "description": "Search query"}
+        },
+        "required": ["query"]
+    },
+    mock_responses=["NYC: 72°F, sunny", "BTC: $67,234"]
+)
+
+# Create pipeline with tools
+pipeline = create_pipeline(
+    dataset_type=DatasetType.TOOL_CALL,
+    tools=[web_search],
+)
+
+# Generate from tool usage guidelines
+dataset = pipeline.generate("""
+Use web_search for real-time data like weather, prices.
+Answer general questions directly without tools.
+""", traces=20)
+
+dataset.save("tool_training.jsonl", format="tool_call")
+```
+
+Output (OpenAI function calling format):
+```json
+{"messages": [
+  {"role": "system", "content": "You have access to: web_search..."},
+  {"role": "user", "content": "What's the weather in NYC?"},
+  {"role": "assistant", "content": null, "tool_calls": [
+    {"id": "call_abc", "type": "function", "function": {"name": "web_search", "arguments": "{\"query\": \"weather NYC\"}"}}
+  ]},
+  {"role": "tool", "tool_call_id": "call_abc", "content": "NYC: 72°F, sunny"},
+  {"role": "assistant", "content": "The weather in NYC is 72°F and sunny."}
+]}
+```
+
+## Evaluation & Grading
+
+Every response is graded on policy compliance, citations, and reasoning. Failed responses are automatically refined (up to N iterations).
+
+```python
+from synkro.pipelines import create_pipeline
+from synkro.models.openai import OpenAI
+
+pipeline = create_pipeline(
+    model=OpenAI.GPT_4O_MINI,       # Fast generation
+    grading_model=OpenAI.GPT_4O,    # Quality grading
+    max_iterations=3,               # Refinement attempts
+)
+
+dataset = pipeline.generate(policy, traces=100)
+
+# Check quality
+print(f"Pass rate: {dataset.passing_rate:.1%}")
+
+# Filter to only passing traces
+high_quality = dataset.filter(passed=True)
+high_quality.save("training.jsonl")
+```
+
+## CLI
+
+```bash
+# From file
+synkro generate policy.pdf --traces 50 --format sft
+
+# From text
+synkro generate "All expenses over $50 need approval" -n 20
+
+# From URL
+synkro generate https://example.com/policy -o training.jsonl
+
+# Skip interactive mode
+synkro generate policy.pdf --no-interactive
+```
+
+**Options:**
+- `--traces, -n` - Number of traces (default: 20)
+- `--format, -f` - Output format: sft, qa, or tool_call (default: sft)
+- `--output, -o` - Output file path
+- `--model, -m` - Model for generation
+- `--interactive/-i, --no-interactive/-I` - Review/edit extracted rules before generation (default: on)
+
+## Interactive Mode
+
+By default, synkro extracts policy rules into a Logic Map and lets you review/edit them before generation:
+
+```
+📜 Logic Map (3 rules extracted)
+├── R001: Expenses over $50 require manager approval
+├── R002: Client meals limited to $75/person
+└── R003: Receipts required for all expenses
+
+Enter feedback (or 'done'): Add a rule for travel expenses over $500
+✓ Added R004: Travel expenses over $500 require VP approval
+
+Enter feedback (or 'done'): done
+```
+
+Commands: `done`, `undo`, `reset`, `show R001`
+
+## Logic Map Inspection
+
+Access the extracted rules programmatically:
+
+```python
+result = pipeline.generate(policy, traces=50, return_logic_map=True)
+
+# Inspect extracted rules
+for rule in result.logic_map.rules:
+    print(f"{rule.rule_id}: {rule.text}")
+
+# Get the dataset
+dataset = result.dataset
+```

synkro-0.4.12.dist-info/RECORD

@@ -0,0 +1,77 @@
+synkro/__init__.py,sha256=z6CqcFG7rfW7nhSKg0bEUnXGmMzPoCY7dBL0nnlRr7c,6129
+synkro/advanced.py,sha256=txqzWM4QJD52QCHdx0ee2fliZgLRuFgzyZzLVf1OfTk,4933
+synkro/cli.py,sha256=PIiLIzQjHWABzSh8k4eMYf3igrGSITbzUPyMmZJy6cE,3181
+synkro/errors.py,sha256=HlzJmlnOdXRb_AtwMTuJeAgy_xTF30KfLmOOCa878gM,5878
+synkro/factory.py,sha256=_oki5uqDyWYR-11ty1K8AO5jGoLtTOuZxVXMTvh7Rhs,10694
+synkro/parsers.py,sha256=YFTHODdxoWT94xj1NNGLGuYNIHlAAV6o_xl6GIoKSz4,13800
+synkro/pipelines.py,sha256=g3JssK4GEgHeiHgZIFMtsLZHzsFgzudsX8rq3IYfZgg,4313
+synkro/reporting.py,sha256=sU2mSPXeHmyYsp4i5XZ4AOckk80zzF9otrWcMgWpnLo,22884
+synkro/schemas.py,sha256=kJHFDx_6yzn29EftA60k7LtHW_Sxr_ztDhbto79WKXM,16371
+synkro/core/__init__.py,sha256=DG4rFXQyJdVQmqBmMDYMNiNlFZwIBrGhp8yw5rB7rEw,167
+synkro/core/checkpoint.py,sha256=EiKWr9btEOPQwsZjmdjyl5SISdrYYPOkCyAgRCLGbv4,8630
+synkro/core/dataset.py,sha256=iB5WxIlwh8MFOaO5is96fCqhK2zs-xOy-lf_UUp3GBE,13082
+synkro/core/policy.py,sha256=waKUtZXXx6-RIKGz5cEzuBpnF26rSTw6OPSbktjrsQs,10592
+synkro/examples/__init__.py,sha256=kMrh5pnL9himSR_uSo2uQxyExyRGAmYucLZ1p5t5NZs,4436
+synkro/formatters/__init__.py,sha256=xMZRPjDRTFcoEOF2XT_bhapzpMafSDsAAtwhhneFIv4,292
+synkro/formatters/qa.py,sha256=_hZbvHR9BYLBK1NpBbZf6BpwsBtFzdvsWZ-P7735gRE,2877
+synkro/formatters/sft.py,sha256=FcweL_SX69WK-K14MzDiUlJYGRa06aTdzirt1Vq5CxA,2470
+synkro/formatters/tool_call.py,sha256=PUVwX6gCW4Qo3vzTy_tELnWXoIJHdCpBn-7kQU2nUFM,4147
+synkro/generation/__init__.py,sha256=AyInSLljvtnTDnhLMHRePecHp1OkcQNVrwUymRJkuNo,348
+synkro/generation/follow_ups.py,sha256=ghzS5jlRO3SPdSgHNe2ML-Ydz5c_vuhpSlm1uHhqf2s,4568
+synkro/generation/generator.py,sha256=4u4Vxk8NT1SweHICazlkijab_Et7nEI6Tfb2wrjCmLE,8406
+synkro/generation/golden_responses.py,sha256=RxQYuTz6ySxnBdF2C1B05aNGdWUuvJ0JcR3GcANzMtA,7848
+synkro/generation/golden_scenarios.py,sha256=CMe_GYkdWwJYxtVV4s5XnYEB0g89j8dYuPTiDNDna4A,9204
+synkro/generation/golden_tool_responses.py,sha256=YaP512GqM2Nn5pXR35xEkUhRllvTCVqRsjDia1qvukU,13929
+synkro/generation/logic_extractor.py,sha256=y_TvNDF5aYw3iQitQa9LPoTHiu3O8fD-csPaUZdR-vI,3848
+synkro/generation/multiturn_responses.py,sha256=pM_mTGUb0yi_q8biWO6TXXE8vj8cKqWXirBrNdo925Y,5592
+synkro/generation/planner.py,sha256=gdEFda3he_YlPii4M6ksc7TYvt2nNN0eesEauTbmYvo,4625
+synkro/generation/responses.py,sha256=zMRTtTzg9hfR6Bwo1iFK-TStSUUYihf3b1p3bTu7JUA,5672
+synkro/generation/scenarios.py,sha256=SrsTrTzLkcBGmME63JcCL0I_guKy931NnpXRVZVgNSs,2717
+synkro/generation/tool_responses.py,sha256=UwjdOS5BWQ6bBPCvP3nKdSOuKBr8daMhlrmcXAbIpEs,12284
+synkro/generation/tool_simulator.py,sha256=lnlPlhKPXZTrv34Fu9J_eTeQcGtN-HYEx06Fi8Z05CA,3640
+synkro/interactive/__init__.py,sha256=gxMAj9rl8yvABs83tRgqENwuLm4Ezpxd1D_czg2oAMM,368
+synkro/interactive/hitl_session.py,sha256=xkpJ9-XcRl8-pw_-WSVS0MiZLTnn-oXIYd3q52Ve-q4,2341
+synkro/interactive/logic_map_editor.py,sha256=wu2cR5OWOPQtAOHyhsoEICEtlHdlAVMOYgfDDCecwSM,5879
+synkro/interactive/rich_ui.py,sha256=VLJ2iF-Wh6Avhyiozxbz4DZODi646YFN4-HQ3dJk7QU,7566
+synkro/llm/__init__.py,sha256=o-mYVn6GoWfZOp8k53TwivcQ92XsqzIsOSo2NLBHKxk,210
+synkro/llm/client.py,sha256=OKjO32UFxaKLeFTpLTYSFywm2LU3mOXK3TpfBhOMwrA,7343
+synkro/llm/rate_limits.py,sha256=lo_HAvfElovW3s6Oj2zpQUvtp81d_KWBFQefbonrEVg,2412
+synkro/models/__init__.py,sha256=h07Gn4c8tMiRMBlOXimxMRKO9Zq4Wom-v5rdlSIaKlY,984
+synkro/models/anthropic.py,sha256=wngs0GrOn13BtM0qGZvFrPoz9vy2T2o19qb0UkeqsQ4,782
+synkro/models/google.py,sha256=J_ePDNzfcbnZOrprGwwMZY-g6hjCFH1rWB6_8yHrlHA,474
+synkro/models/openai.py,sha256=HD9P_GTYpaX7nfdBreYTuEWpoN1g0oosPIQQL7BgThs,699
+synkro/modes/__init__.py,sha256=HF1mL-4gAPQAd5InOn5YM7k2x8YF4hWZtdJw3I4CRKw,362
+synkro/modes/config.py,sha256=Q3ZyNB-wPWj7emcJ4MTiC_Z1LEfTNfyWxiEQ-W6UYnU,1700
+synkro/modes/qa.py,sha256=xtaW6JGaJH5dua0Zf0gxnuo0yZhh8Wu1Yb1OK_z5twM,463
+synkro/modes/sft.py,sha256=oVijQlXYT1CgzXYE2wf4vAmxTja5wZxG8ii3F-5XEA4,506
+synkro/modes/tool_call.py,sha256=EWdG_cb6eN3OP3JGxvwjH_1aKXSX0PgPT7MoBuxoqkM,518
+synkro/pipeline/__init__.py,sha256=cyDk301kmJYE7ro3eO4bLiQWhpMqvUqL5zIMG_1t1pU,398
+synkro/pipeline/phases.py,sha256=7Nqqd5UKV0kUQZypZi9c5NvohxFgi88Y7iCcf72SG6g,19598
+synkro/pipeline/runner.py,sha256=0xpcZTwueMLFB8aHDU_X5qEkZqUmw_H0zz3cBYkxO14,16599
+synkro/prompts/__init__.py,sha256=kzxPkQ0ffHxMCgQrVBNtihh8PrmO8VDkhWzgX62p2JY,1400
+synkro/prompts/base.py,sha256=TZv21qqTJ6huazueclkCQEsDbRkind9PqP4eTk99g5A,4587
+synkro/prompts/golden_templates.py,sha256=vraPzOxu-zK6B1Ea62gMhguqXfpBXyTPzTzCjuyAywE,18202
+synkro/prompts/interactive_templates.py,sha256=K1Y5S5O-D8QrBCXxr3TeER1ZAkgmGnjqer92DKZCpNA,2678
+synkro/prompts/multiturn_templates.py,sha256=JhAD0AIi6Y_hEERjXkZN_xQtwn6TjW0mbE4QOB1IpIQ,5386
+synkro/prompts/qa_templates.py,sha256=tJzDwDo6ReTUZCzumxlDMl9BOwztnL1aFnGkj6ceSeM,2726
+synkro/prompts/templates.py,sha256=VfAW5PkBVOMzEAbLhxyUHR2yC2HQcDA5-7h1vOdtPRE,13147
+synkro/prompts/tool_templates.py,sha256=XLhy6tvO9m5sctMPRGBLeS3LDp6V4woWE_YkojPmnq0,6242
+synkro/quality/__init__.py,sha256=EBTJaJ7PgnxY5-bSAYWROL_YNK9KSwledqrtlAO8YgM,352
+synkro/quality/golden_refiner.py,sha256=0ZC1hOz5k6P5sbBKtDnIgfkbQrwMzrKxFkj2gH0IN10,5801
+synkro/quality/grader.py,sha256=bNB3HaqtGpbVcdPBio8LRTPstkbGle9z-V3Wh2l5248,4908
+synkro/quality/multiturn_grader.py,sha256=BPvjn3qZADqcA-daXG6G-nzl7PArnooOxw1-WZGFCOI,5162
+synkro/quality/refiner.py,sha256=bg6mVaIfAqHy1Zk1QCM-debkNxLlfGaeKEqFe8NLImo,4007
+synkro/quality/tool_grader.py,sha256=k9zVgsTxTt6vWG-cZXu7SHIKoWPhq-lOWlWRr4w-HWU,4427
+synkro/quality/tool_refiner.py,sha256=HARfJa8RdIkU5LewnQy2JZ-43cHtWMcBerZriYD_LSo,4574
+synkro/quality/verifier.py,sha256=lA56Q99DGdSFOwOunNdapccuKa3d1W_uQwlHbAVkFsQ,8643
+synkro/types/__init__.py,sha256=PH8uNYHGadGhF9hdbbCpsviDlA855y9X0rWbcsh1T0s,711
+synkro/types/core.py,sha256=IkEf82k3fU9cUsaSVXGRx_SZhv5qiLEQN3rIDbfPG24,4570
+synkro/types/dataset_type.py,sha256=qgcDNVThniQ09xHyfigVmfG8-TEk81L3mFjQxnn51gU,857
+synkro/types/logic_map.py,sha256=6PqUlsPwer78Ab7BDaM57uHZ8Gti1qM1Z-7hqugez7s,10726
+synkro/types/tool.py,sha256=Zej5UWWYqYxEyRhDclxc_Fkdt7aQiE7hNnEeR5DJb9w,3232
+synkro-0.4.12.data/data/examples/__init__.py,sha256=kMrh5pnL9himSR_uSo2uQxyExyRGAmYucLZ1p5t5NZs,4436
+synkro-0.4.12.dist-info/METADATA,sha256=gEab5DYGQMbsWXS7bVSDHn4g2zykdCMuBkQiiFMsdRw,7201
+synkro-0.4.12.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+synkro-0.4.12.dist-info/entry_points.txt,sha256=trxD69adEHCwUkRdvJ5-elW5BIHzx77QRTM_cxK5mzk,43
+synkro-0.4.12.dist-info/licenses/LICENSE,sha256=-L5MVraHKLJI1BfHTaTPSkNuWMWYkQroo2g1FwdRDQw,1070
+synkro-0.4.12.dist-info/RECORD,,

synkro-0.4.12.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.28.0
+Root-Is-Purelib: true
+Tag: py3-none-any

synkro-0.4.12.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+synkro = synkro.cli:main

synkro-0.4.12.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Murtaza Meerza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.