edgenote 0.1.0__py3-none-any.whl

edgenote/__init__.py

@@ -0,0 +1,113 @@
+"""edgenote — place important notes at the edges of your LLM prompts.
+
+Addresses the "lost in the middle" attention problem (Liu et al., 2023) by
+pinning key information at the *head* and *tail* of the assembled prompt while
+keeping bulk context in the middle.  No LLM calls, no disk persistence.
+
+**100% zero-dependency core** — sentence-transformers, tiktoken, transformers,
+and other heavy libraries are imported *dynamically* only when you explicitly
+use a backend that requires them.
+
+Basic usage::
+
+    from edgenote import Session
+
+    s = Session()
+    s.pin("Budget is $500")
+    s.add("Doc A: project overview …", relevance=0.9)
+    s.add("Doc B: cost breakdown …",  relevance=0.4)
+
+    result = s.render("Which option fits the budget?")
+    print(result.text)
+
+    # Or turn it into an API-ready message list:
+    messages = result.to_messages()
+
+Advanced — zero-dep backends (always available)::
+
+    from edgenote import Session
+    from edgenote.reranker import BM25Reranker, TFIDFReranker
+    from edgenote.chunker import StructuralChunker
+    from edgenote.tokenizers import RegexTokenizer
+
+    s = Session(reranker=BM25Reranker())          # pure Python BM25
+    s = Session(reranker=TFIDFReranker())         # pure Python TF-IDF cosine
+    s = Session(token_counter=RegexTokenizer())   # BPE-approximate counter
+
+    chunker = StructuralChunker(max_tokens=256)   # Markdown-aware, zero-dep
+    chunks = chunker.chunk(long_markdown_doc)
+
+Advanced — optional heavy backends (dynamically loaded)::
+
+    from edgenote import Session
+    from edgenote.tokenizers import auto_tokenizer
+    from edgenote.integrations import from_langchain, from_llamaindex, from_dicts
+
+    # Real token counting (always available, tiktoken & transformers auto-installed)
+    s = Session(token_counter="gpt-4o")
+
+    # Semantic reranking — requires: pip install edgenote[rerank]
+    s = Session(reranker="cross-encoder")         # CrossEncoderReranker
+    s = Session(reranker="embedding")             # EmbeddingReranker
+
+    # Semantic chunking — requires: pip install edgenote[chunker]
+    s = Session(chunker="semantic")
+
+    # LLM-based context compression
+    s = Session(compressor=my_summarize_fn)
+"""
+
+from .session import Rendered, Session
+from .style import Style
+from .tokens import estimate_tokens
+from .tokenizers import auto_tokenizer, CharEstimator, RegexTokenizer, TokenCounter
+from .reranker import (
+    Reranker,
+    NoopReranker,
+    BM25Reranker,
+    TFIDFReranker,
+    CrossEncoderReranker,
+    EmbeddingReranker,
+)
+from .compressor import Compressor, DropCompressor, LLMSummarizer
+from .chunker import Chunker, FixedChunker, StructuralChunker, SemanticChunker
+from .downloader import set_auto_install
+from . import integrations
+
+__all__ = [
+    # Core
+    "Session",
+    "Rendered",
+    "Style",
+    # Tokenizers
+    "auto_tokenizer",
+    "CharEstimator",
+    "RegexTokenizer",
+    "TokenCounter",
+    "estimate_tokens",
+    # Rerankers (zero-dep)
+    "Reranker",
+    "NoopReranker",
+    "BM25Reranker",
+    "TFIDFReranker",
+    # Rerankers (optional heavy, dynamically loaded)
+    "CrossEncoderReranker",
+    "EmbeddingReranker",
+    # Compressors
+    "Compressor",
+    "DropCompressor",
+    "LLMSummarizer",
+    # Chunkers (zero-dep)
+    "Chunker",
+    "FixedChunker",
+    "StructuralChunker",
+    # Chunkers (optional heavy, dynamically loaded)
+    "SemanticChunker",
+    # Auto-installer
+    "set_auto_install",
+    # Integrations
+    "integrations",
+]
+
+__version__ = "0.1.0"
+__author__ = "Md Tareq Shah Alam"

edgenote/__main__.py

@@ -0,0 +1,144 @@
+"""
+edgenote CLI entry point.
+Run with:
+    edgenote
+    python -m edgenote
+    python -m edgenote --demo
+"""
+
+import sys
+from edgenote import Session, Style, __version__
+
+# ANSI escape codes for stylish terminal styling
+CYAN    = "\033[96m"
+MAGENTA = "\033[95m"
+GREEN   = "\033[92m"
+YELLOW  = "\033[93m"
+BOLD    = "\033[1m"
+DIM     = "\033[2m"
+RESET   = "\033[0m"
+
+
+BANNER = f"""{CYAN}{BOLD}
+   ____   _                          _       
+  / __ \\ | |                        | |      
+ | |  | || |   __ _   ___  _ __    | |_ ___ 
+ | |  | || |  / _` | / _ \\| '_ \\   | __/ _ \\
+ | |__| || | | (_| ||  __/| | | |  | ||  __/
+  \\____/ |_|  \\__, | \\___||_| |_|   \\__\\___|
+               __/ |                         
+              |___/                          
+{MAGENTA}  * Prompt Edge-Pinning Framework for LLMs *{RESET}
+"""
+
+
+LINKEDIN_URL = "https://www.linkedin.com/in/md-tareq-shah-alam/"
+
+
+def make_hyperlink(url: str, text: str) -> str:
+    """Wrap text in an OSC 8 terminal hyperlink escape sequence."""
+    return f"\033]8;;{url}\033\\{text}\033]8;;\033\\"
+
+
+def print_banner() -> None:
+    print(BANNER)
+    author_text = f"{YELLOW}{BOLD}Md Tareq Shah Alam{RESET}"
+    author_linked = make_hyperlink(LINKEDIN_URL, author_text)
+    linkedin_text = f"{CYAN}{LINKEDIN_URL}{RESET}"
+    linkedin_linked = make_hyperlink(LINKEDIN_URL, linkedin_text)
+
+    print(f"  {BOLD}Package   :{RESET} {CYAN}edgenote{RESET}")
+    print(f"  {BOLD}Version   :{RESET} {GREEN}v{__version__}{RESET}")
+    print(f"  {BOLD}Author    :{RESET} {author_linked}")
+    print(f"  {BOLD}LinkedIn  :{RESET} {linkedin_linked}")
+    print(f"  {BOLD}License   :{RESET} Proprietary (All Rights Reserved)")
+    print(f"  {BOLD}Purpose   :{RESET} Fight 'Lost in the Middle' attention degradation")
+    print()
+    print(f"  {DIM}-------------------------------------------------------------{RESET}")
+    print()
+
+
+def run_demo() -> None:
+    print(f"  {BOLD}{MAGENTA}[ Live Demonstration ]{RESET}\n")
+
+    s = Session(style=Style(
+        head_title="Key Constraints (Read First)",
+        tail_title="Key Constraints (Reminder)",
+        body_title="Retrieved Knowledge",
+        question_label="Query",
+    ))
+
+    # 1. Edge-pinned note
+    s.pin("The total hardware budget is strictly capped at $185,000.", label="Budget Cap")
+
+    # 2. Context chunks
+    s.add("Server Hall cooling upgrade proposal: Tier-3 standard liquid loop.", relevance=0.7)
+    s.add("Vendor A quotation: 64-chip acceleration cluster at $240,000.", relevance=0.9)
+    s.add("Vendor B quotation: 48-chip acceleration cluster at $180,000.", relevance=0.85)
+
+    result = s.render("Which vendor quotation qualifies under our budget?")
+
+    print(f"{YELLOW}{BOLD}Prompt Rendered by edgenote:{RESET}\n")
+    print(f"{DIM}{'-' * 60}{RESET}")
+    print(result.user_text)
+    print(f"{DIM}{'-' * 60}{RESET}\n")
+    print(f"  {GREEN}[+] Token estimate :{RESET} ~{result.tokens} tokens")
+    print(f"  {GREEN}[+] Pin overhead   :{RESET} +{result.pin_overhead} tokens")
+    print(f"  {GREEN}[+] Status         :{RESET} Both head & tail edges fortified against attention loss.\n")
+
+
+def main() -> None:
+    args = sys.argv[1:]
+
+    if args and args[0] == "install":
+        from edgenote.downloader import EXTRAS, install
+        venv_path, positional, i = None, [], 1
+        while i < len(args):
+            a = args[i]
+            if a == "--venv":
+                if i + 1 >= len(args):
+                    print("--venv requires a path"); sys.exit(1)
+                venv_path = args[i + 1]; i += 2; continue
+            if a.startswith("--venv="):
+                venv_path = a.split("=", 1)[1]
+            elif not a.startswith("-"):
+                positional.append(a)
+            i += 1
+        extra = positional[0] if positional else "all"
+        if extra not in EXTRAS:
+            print(f"Unknown extra. Choose from: {', '.join(EXTRAS)}"); sys.exit(1)
+        confirm = "--yes" not in args
+        break_sys = "--break-system-packages" in args
+        sys.exit(0 if install(extra, confirm=confirm, break_system_packages=break_sys, venv_path=venv_path) else 1)
+
+    if "--version" in args or "-v" in args:
+        author_linked = make_hyperlink(LINKEDIN_URL, "Md Tareq Shah Alam")
+        print(f"edgenote v{__version__} by {author_linked} ({LINKEDIN_URL})")
+        return
+
+    if "--help" in args or "-h" in args:
+        print_banner()
+        print("Usage:")
+        print("    edgenote                                       Show credits and quick usage")
+        print("    edgenote install [extra] [--venv PATH] [--yes] Install optional extras (rerank, chunker, regex, all)")
+        print("    edgenote --demo                                Run an interactive edge-pinning prompt demo")
+        print("    edgenote --version                             Show version and author info")
+        return
+
+    print_banner()
+
+    if "--demo" in args:
+        run_demo()
+    else:
+        print(f"  {BOLD}Quick Start:{RESET}")
+        print(f"    {CYAN}from edgenote import Session{RESET}")
+        print(f"    {CYAN}s = Session(){RESET}")
+        print(f"    {CYAN}s.pin('Budget is strictly $185,000', label='Constraint'){RESET}")
+        print(f"    {CYAN}s.add('Doc 1: details ...', relevance=0.9){RESET}")
+        print(f"    {CYAN}res = s.render('Which option fits?'){RESET}")
+        print()
+        print(f"  {DIM}Run {RESET}{GREEN}python -m edgenote --demo{RESET}{DIM} to see prompt assembly in action.{RESET}\n")
+
+
+if __name__ == "__main__":
+    main()