5173 lines
No EOL
402 KiB
HTML
5173 lines
No EOL
402 KiB
HTML
|
|
<!doctype html>
|
|
<html lang="en" class="no-js">
|
|
<head>
|
|
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width,initial-scale=1">
|
|
|
|
<meta name="description" content="GreatAI helps you easily transform your prototype AI code into production-ready software.">
|
|
|
|
|
|
<meta name="author" content="András Schmelczer">
|
|
|
|
|
|
<link rel="icon" href="../media/favicon.ico">
|
|
<meta name="generator" content="mkdocs-1.3.0, mkdocs-material-8.3.9">
|
|
|
|
|
|
|
|
<title>GreatAI reference - GreatAI documentation</title>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.1d29e8d0.min.css">
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/stylesheets/palette.cbb835fc.min.css">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
|
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
|
|
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
|
|
|
|
|
|
|
|
<link rel="stylesheet" href="../assets/_mkdocstrings.css">
|
|
|
|
<script>__md_scope=new URL("..",location),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
|
|
|
|
|
|
|
|
|
|
|
|
<meta property="og:title" content="">
|
|
<meta property="og:site_name" content="">
|
|
<meta property="og:url" content="">
|
|
<meta property="og:description" content="Transform your prototype AI code into production-ready software.">
|
|
<meta property="og:type" content="">
|
|
<meta property="og:image" content=https://great-ai.scoutinscience.com/media/og-image.png>
|
|
|
|
<style>
|
|
.jupyter-wrapper a {
|
|
color: var(--md-typeset-a-color) !important;
|
|
}
|
|
</style>
|
|
|
|
</head>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="light-blue" data-md-color-accent="">
|
|
|
|
|
|
|
|
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
|
|
|
|
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
|
|
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
|
|
<label class="md-overlay" for="__drawer"></label>
|
|
<div data-md-component="skip">
|
|
|
|
|
|
<a href="#greatai-reference" class="md-skip">
|
|
Skip to content
|
|
</a>
|
|
|
|
</div>
|
|
<div data-md-component="announce">
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<header class="md-header" data-md-component="header">
|
|
<nav class="md-header__inner md-grid" aria-label="Header">
|
|
<a href=".." title="GreatAI documentation" class="md-header__button md-logo" aria-label="GreatAI documentation" data-md-component="logo">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
|
|
|
|
</a>
|
|
<label class="md-header__button md-icon" for="__drawer">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></svg>
|
|
</label>
|
|
<div class="md-header__title" data-md-component="header-title">
|
|
<div class="md-header__ellipsis">
|
|
<div class="md-header__topic">
|
|
<span class="md-ellipsis">
|
|
GreatAI documentation
|
|
</span>
|
|
</div>
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
|
<span class="md-ellipsis">
|
|
|
|
GreatAI reference
|
|
|
|
</span>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<form class="md-header__option" data-md-component="palette">
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="light-blue" data-md-color-accent="" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 0-7 7c0 2.38 1.19 4.47 3 5.74V17a1 1 0 0 0 1 1h6a1 1 0 0 0 1-1v-2.26c1.81-1.27 3-3.36 3-5.74a7 7 0 0 0-7-7M9 21a1 1 0 0 0 1 1h4a1 1 0 0 0 1-1v-1H9v1Z"/></svg>
|
|
</label>
|
|
|
|
|
|
|
|
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="light-blue" data-md-color-accent="" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
|
|
|
|
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 2a7 7 0 0 1 7 7c0 2.38-1.19 4.47-3 5.74V17a1 1 0 0 1-1 1H9a1 1 0 0 1-1-1v-2.26C6.19 13.47 5 11.38 5 9a7 7 0 0 1 7-7M9 21v-1h6v1a1 1 0 0 1-1 1h-4a1 1 0 0 1-1-1m3-17a5 5 0 0 0-5 5c0 2.05 1.23 3.81 3 4.58V16h4v-2.42c1.77-.77 3-2.53 3-4.58a5 5 0 0 0-5-5Z"/></svg>
|
|
</label>
|
|
|
|
|
|
</form>
|
|
|
|
|
|
|
|
<label class="md-header__button md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
</label>
|
|
<div class="md-search" data-md-component="search" role="dialog">
|
|
<label class="md-search__overlay" for="__search"></label>
|
|
<div class="md-search__inner" role="search">
|
|
<form class="md-search__form" name="search">
|
|
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
|
|
<label class="md-search__icon md-icon" for="__search">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"/></svg>
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
|
</label>
|
|
<nav class="md-search__options" aria-label="Search">
|
|
|
|
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
|
|
</button>
|
|
</nav>
|
|
|
|
</form>
|
|
<div class="md-search__output">
|
|
<div class="md-search__scrollwrap" data-md-scrollfix>
|
|
<div class="md-search-result" data-md-component="search-result">
|
|
<div class="md-search-result__meta">
|
|
Initializing search
|
|
</div>
|
|
<ol class="md-search-result__list"></ol>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-header__source">
|
|
<a href="https://github.com/schmelczer/great-ai" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
schmelczer/great-ai
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
</header>
|
|
|
|
<div class="md-container" data-md-component="container">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<main class="md-main" data-md-component="main">
|
|
<div class="md-main__inner md-grid">
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
|
|
<label class="md-nav__title" for="__drawer">
|
|
<a href=".." title="GreatAI documentation" class="md-nav__button md-logo" aria-label="GreatAI documentation" data-md-component="logo">
|
|
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
|
|
|
|
</a>
|
|
GreatAI documentation
|
|
</label>
|
|
|
|
<div class="md-nav__source">
|
|
<a href="https://github.com/schmelczer/great-ai" title="Go to repository" class="md-source" data-md-component="source">
|
|
<div class="md-source__icon md-icon">
|
|
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
|
|
</div>
|
|
<div class="md-source__repository">
|
|
schmelczer/great-ai
|
|
</div>
|
|
</a>
|
|
</div>
|
|
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href=".." class="md-nav__link">
|
|
Overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_2">
|
|
Tutorial
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Tutorial" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_2">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Tutorial
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../tutorial/" class="md-nav__link">
|
|
Tutorial overview
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../tutorial/train/" class="md-nav__link">
|
|
Train your model
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../tutorial/deploy/" class="md-nav__link">
|
|
Harden and deploy your app
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_3">
|
|
User Guides
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="User Guides" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_3">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
User Guides
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/install/" class="md-nav__link">
|
|
Installation guide
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/create-service/" class="md-nav__link">
|
|
How to create a GreatAI service
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/configure-service/" class="md-nav__link">
|
|
How to configure GreatAI
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/use-service/" class="md-nav__link">
|
|
How to perform prediction with GreatAI
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/handle-training-data/" class="md-nav__link">
|
|
How to manage training data
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/large-file/" class="md-nav__link">
|
|
How to use LargeFiles
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../how-to-guides/call-remote/" class="md-nav__link">
|
|
How to call remote GreatAI instances
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" checked>
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_4">
|
|
Reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Reference" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_4">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Reference
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--active">
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link md-nav__link--active" for="__toc">
|
|
GreatAI reference
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
|
GreatAI reference
|
|
</a>
|
|
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#core" class="md-nav__link">
|
|
Core
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Core">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.GreatAI" class="md-nav__link">
|
|
GreatAI
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="GreatAI">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.deploy.great_ai.GreatAI.create" class="md-nav__link">
|
|
create()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.deploy.great_ai.GreatAI.process_batch" class="md-nav__link">
|
|
process_batch()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.configure" class="md-nav__link">
|
|
configure()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.save_model" class="md-nav__link">
|
|
save_model()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.use_model" class="md-nav__link">
|
|
use_model()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.parameter" class="md-nav__link">
|
|
parameter()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.log_metric" class="md-nav__link">
|
|
log_metric()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remote-calls" class="md-nav__link">
|
|
Remote calls
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Remote calls">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.call_remote_great_ai" class="md-nav__link">
|
|
call_remote_great_ai()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.call_remote_great_ai_async" class="md-nav__link">
|
|
call_remote_great_ai_async()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ground-truth" class="md-nav__link">
|
|
Ground-truth
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Ground-truth">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.add_ground_truth" class="md-nav__link">
|
|
add_ground_truth()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.query_ground_truth" class="md-nav__link">
|
|
query_ground_truth()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.delete_ground_truth" class="md-nav__link">
|
|
delete_ground_truth()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tracing-databases" class="md-nav__link">
|
|
Tracing databases
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Tracing databases">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.TracingDatabaseDriver" class="md-nav__link">
|
|
TracingDatabaseDriver
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.MongoDbDriver" class="md-nav__link">
|
|
MongoDbDriver
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="MongoDbDriver">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.persistence.mongodb_driver.MongoDbDriver.configure_credentials" class="md-nav__link">
|
|
configure_credentials()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.ParallelTinyDbDriver" class="md-nav__link">
|
|
ParallelTinyDbDriver
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="utilities/" class="md-nav__link">
|
|
Utilities
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="large-file/" class="md-nav__link">
|
|
LargeFile
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="views/" class="md-nav__link">
|
|
View models
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5">
|
|
Examples
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Examples" data-md-level="1">
|
|
<label class="md-nav__title" for="__nav_5">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Examples
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item md-nav__item--nested">
|
|
|
|
|
|
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5_1" type="checkbox" id="__nav_5_1" >
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__link" for="__nav_5_1">
|
|
Explainable Naive Bayes
|
|
<span class="md-nav__icon md-icon"></span>
|
|
</label>
|
|
|
|
<nav class="md-nav" aria-label="Explainable Naive Bayes" data-md-level="2">
|
|
<label class="md-nav__title" for="__nav_5_1">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Explainable Naive Bayes
|
|
</label>
|
|
<ul class="md-nav__list" data-md-scrollfix>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../examples/simple/data/" class="md-nav__link">
|
|
Simple example: data engineering
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../examples/simple/train/" class="md-nav__link">
|
|
Optimise and train a model
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../examples/simple/deploy/" class="md-nav__link">
|
|
Hardening and deployment
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../examples/scibert/" class="md-nav__link">
|
|
Explainable SciBERT
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<li class="md-nav__item">
|
|
<a href="../explanation/" class="md-nav__link">
|
|
Explanation
|
|
</a>
|
|
</li>
|
|
|
|
|
|
|
|
</ul>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
|
|
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
|
|
<div class="md-sidebar__scrollwrap">
|
|
<div class="md-sidebar__inner">
|
|
|
|
|
|
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<label class="md-nav__title" for="__toc">
|
|
<span class="md-nav__icon md-icon"></span>
|
|
Table of contents
|
|
</label>
|
|
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#core" class="md-nav__link">
|
|
Core
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Core">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.GreatAI" class="md-nav__link">
|
|
GreatAI
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="GreatAI">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.deploy.great_ai.GreatAI.create" class="md-nav__link">
|
|
create()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.deploy.great_ai.GreatAI.process_batch" class="md-nav__link">
|
|
process_batch()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.configure" class="md-nav__link">
|
|
configure()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.save_model" class="md-nav__link">
|
|
save_model()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.use_model" class="md-nav__link">
|
|
use_model()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.parameter" class="md-nav__link">
|
|
parameter()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.log_metric" class="md-nav__link">
|
|
log_metric()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#remote-calls" class="md-nav__link">
|
|
Remote calls
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Remote calls">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.call_remote_great_ai" class="md-nav__link">
|
|
call_remote_great_ai()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.call_remote_great_ai_async" class="md-nav__link">
|
|
call_remote_great_ai_async()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#ground-truth" class="md-nav__link">
|
|
Ground-truth
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Ground-truth">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.add_ground_truth" class="md-nav__link">
|
|
add_ground_truth()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.query_ground_truth" class="md-nav__link">
|
|
query_ground_truth()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.delete_ground_truth" class="md-nav__link">
|
|
delete_ground_truth()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#tracing-databases" class="md-nav__link">
|
|
Tracing databases
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="Tracing databases">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.TracingDatabaseDriver" class="md-nav__link">
|
|
TracingDatabaseDriver
|
|
</a>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.MongoDbDriver" class="md-nav__link">
|
|
MongoDbDriver
|
|
</a>
|
|
|
|
<nav class="md-nav" aria-label="MongoDbDriver">
|
|
<ul class="md-nav__list">
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.persistence.mongodb_driver.MongoDbDriver.configure_credentials" class="md-nav__link">
|
|
configure_credentials()
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
<li class="md-nav__item">
|
|
<a href="#great_ai.ParallelTinyDbDriver" class="md-nav__link">
|
|
ParallelTinyDbDriver
|
|
</a>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
</nav>
|
|
|
|
</li>
|
|
|
|
</ul>
|
|
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
<div class="md-content" data-md-component="content">
|
|
<article class="md-content__inner md-typeset">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<a href="https://github.com/schmelczer/great-ai/edit/main/docs/reference/index.md" title="Edit this page" class="md-content__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
<h1 id="greatai-reference">GreatAI reference<a class="headerlink" href="#greatai-reference" title="Permanent link">#</a></h1>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="kn">from</span> <span class="nn">great_ai</span> <span class="kn">import</span> <span class="o">*</span>
|
|
</code></pre></div>
|
|
<h2 id="core">Core<a class="headerlink" href="#core" title="Permanent link">#</a></h2>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="great_ai.GreatAI" class="doc doc-heading">
|
|
<code>GreatAI</code>
|
|
|
|
|
|
<a href="#great_ai.GreatAI" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="typing.Generic">Generic</span>[<span title="great_ai.deploy.great_ai.T">T</span>, <span title="great_ai.deploy.great_ai.V">V</span>]</code></p>
|
|
|
|
|
|
<p>Wrapper for a prediction function providing the implementation of SE4ML best-practices.</p>
|
|
<p>Provides caching (with argument freezing), a TracingContext during execution, the
|
|
scaffolding of HTTP endpoints using FastAPI and a dashboard using Dash.</p>
|
|
<p>IMPORTANT: when a request is served from cache, no new trace is created. Thus, the
|
|
same trace can be returned multiple times. If this is undesirable turn off caching
|
|
using <code>configure(prediction_cache_size=0)</code>.</p>
|
|
<p>Supports wrapping async and synchronous functions while also maintaining correct
|
|
typing.</p>
|
|
|
|
<p><strong>Attributes:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>app</code></td>
|
|
<td>
|
|
</td>
|
|
<td><p>FastAPI instance wrapping the scaffolded endpoints and the Dash app.</p></td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>version</code></td>
|
|
<td>
|
|
</td>
|
|
<td><p>SemVer derived from the app's version and the model names and versions
|
|
registered through use_model.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/deploy/great_ai.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-44"> 44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45"> 45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46"> 46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47"> 47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48"> 48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49"> 49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50"> 50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51"> 51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52"> 52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53"> 53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54"> 54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55"> 55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56"> 56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57"> 57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58"> 58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59"> 59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60"> 60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61"> 61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62"> 62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63"> 63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64"> 64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65"> 65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66"> 66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67"> 67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68"> 68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69"> 69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70"> 70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71"> 71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72"> 72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73"> 73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74"> 74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75"> 75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76"> 76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77"> 77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78"> 78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79"> 79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80"> 80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81"> 81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82"> 82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83"> 83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84"> 84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85"> 85</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-86"> 86</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-87"> 87</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-88"> 88</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-89"> 89</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-90"> 90</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-91"> 91</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-92"> 92</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-93"> 93</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-114">114</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-116">116</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-117">117</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-119">119</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-120">120</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-121">121</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-122">122</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-123">123</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-124">124</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-125">125</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-126">126</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-127">127</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-128">128</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-129">129</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-130">130</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-131">131</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-132">132</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-133">133</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-134">134</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-135">135</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-136">136</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-137">137</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-138">138</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-139">139</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-140">140</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-141">141</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-142">142</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-143">143</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-144">144</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-145">145</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-150">150</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-151">151</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-152">152</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-153">153</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-154">154</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-155">155</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-157">157</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-158">158</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-159">159</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-160">160</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-161">161</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-162">162</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-163">163</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-164">164</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-165">165</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-166">166</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-167">167</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-168">168</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-169">169</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-170">170</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-171">171</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-172">172</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-173">173</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-174">174</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-175">175</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-176">176</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-177">177</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-178">178</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-179">179</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-180">180</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-181">181</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-182">182</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-183">183</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-184">184</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-185">185</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-186">186</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-187">187</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-188">188</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-189">189</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-190">190</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-191">191</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-192">192</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-193">193</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-194">194</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-195">195</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-196">196</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-197">197</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-198">198</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-199">199</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-200">200</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-201">201</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-202">202</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-203">203</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-204">204</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-205">205</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-206">206</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-207">207</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-208">208</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-209">209</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-210">210</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-211">211</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-212">212</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-213">213</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-214">214</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-215">215</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-216">216</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-217">217</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-218">218</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-219">219</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-220">220</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-221">221</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-222">222</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-223">223</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-224">224</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-225">225</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-226">226</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-227">227</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-228">228</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-229">229</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-230">230</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-231">231</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-232">232</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-233">233</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-234">234</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-235">235</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-236">236</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-237">237</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-238">238</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-239">239</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-240">240</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-241">241</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-242">242</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-243">243</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-244">244</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-245">245</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-246">246</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-247">247</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-248">248</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-249">249</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-250">250</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-251">251</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-252">252</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-253">253</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-254">254</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-255">255</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-256">256</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-257">257</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-258">258</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-259">259</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-260">260</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-261">261</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-262">262</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-263">263</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-264">264</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-265">265</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-266">266</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-267">267</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-268">268</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-269">269</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-270">270</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-271">271</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-272">272</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-273">273</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-274">274</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-275">275</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-276">276</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-277">277</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-278">278</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-279">279</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-280">280</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-281">281</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-282">282</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-283">283</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-284">284</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-285">285</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-286">286</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-287">287</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-288">288</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-289">289</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-290">290</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-291">291</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-292">292</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-293">293</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-294">294</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-295">295</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-296">296</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-297">297</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-298">298</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-299">299</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-300">300</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-301">301</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-302">302</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-303">303</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-304">304</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-305">305</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-306">306</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-307">307</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-308">308</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-309">309</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-310">310</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-311">311</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-312">312</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-313">313</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-314">314</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-315">315</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-316">316</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-317">317</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-318">318</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-319">319</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-320">320</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-321">321</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="k">class</span> <span class="nc">GreatAI</span><span class="p">(</span><span class="n">Generic</span><span class="p">[</span><span class="n">T</span><span class="p">,</span> <span class="n">V</span><span class="p">]):</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a> <span class="sd">"""Wrapper for a prediction function providing the implementation of SE4ML best-practices.</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a><span class="sd"> Provides caching (with argument freezing), a TracingContext during execution, the</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a><span class="sd"> scaffolding of HTTP endpoints using FastAPI and a dashboard using Dash.</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="sd"> IMPORTANT: when a request is served from cache, no new trace is created. Thus, the</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="sd"> same trace can be returned multiple times. If this is undesirable turn off caching</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd"> using `configure(prediction_cache_size=0)`.</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="sd"> Supports wrapping async and synchronous functions while also maintaining correct</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="sd"> typing.</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a><span class="sd"> Attributes:</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="sd"> app: FastAPI instance wrapping the scaffolded endpoints and the Dash app.</span>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> version: SemVer derived from the app's version and the model names and versions</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a><span class="sd"> registered through use_model.</span>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="vm">__name__</span><span class="p">:</span> <span class="nb">str</span> <span class="c1"># help for MyPy</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a> <span class="vm">__doc__</span><span class="p">:</span> <span class="nb">str</span> <span class="c1"># help for MyPy</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Union</span><span class="p">[</span><span class="n">V</span><span class="p">,</span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">V</span><span class="p">]]],</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="p">):</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="sd">"""Do not call this function directly, use GreatAI.create instead."""</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="n">func</span> <span class="o">=</span> <span class="n">automatically_decorate_parameters</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="n">get_function_metadata_store</span><span class="p">(</span><span class="n">func</span><span class="p">)</span><span class="o">.</span><span class="n">is_finalised</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_func</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_get_cached_traced_function</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped_func</span> <span class="o">=</span> <span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)(</span><span class="n">freeze_arguments</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_cached_func</span><span class="p">))</span>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="n">wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)(</span><span class="bp">self</span><span class="p">)</span>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span> <span class="o">=</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="sa">f</span><span class="s2">"GreatAI wrapper for interacting with the `</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">` "</span>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="o">+</span> <span class="sa">f</span><span class="s2">"function.</span><span class="se">\n\n</span><span class="si">{</span><span class="n">dedent</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span> <span class="ow">or</span> <span class="s1">''</span><span class="p">)</span><span class="si">}</span><span class="s2">"</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">version</span><span class="p">)</span>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="n">flat_model_versions</span> <span class="o">=</span> <span class="s2">"."</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">k</span><span class="si">}</span><span class="s2">-v</span><span class="si">{</span><span class="n">v</span><span class="si">}</span><span class="s2">"</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">model_versions</span><span class="p">)</span>
|
|
<a id="__codelineno-0-86" name="__codelineno-0-86"></a> <span class="k">if</span> <span class="n">flat_model_versions</span><span class="p">:</span>
|
|
<a id="__codelineno-0-87" name="__codelineno-0-87"></a> <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">+=</span> <span class="sa">f</span><span class="s2">"+</span><span class="si">{</span><span class="n">flat_model_versions</span><span class="si">}</span><span class="s2">"</span>
|
|
<a id="__codelineno-0-88" name="__codelineno-0-88"></a>
|
|
<a id="__codelineno-0-89" name="__codelineno-0-89"></a> <span class="bp">self</span><span class="o">.</span><span class="n">app</span> <span class="o">=</span> <span class="n">FastAPI</span><span class="p">(</span>
|
|
<a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="n">title</span><span class="o">=</span><span class="n">snake_case_to_text</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="vm">__name__</span><span class="p">),</span>
|
|
<a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="n">version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span>
|
|
<a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="n">description</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span>
|
|
<a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="o">+</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\n\n</span><span class="s2">Find out more in the [dashboard](</span><span class="si">{</span><span class="n">DASHBOARD_PATH</span><span class="si">}</span><span class="s2">)."</span><span class="p">,</span>
|
|
<a id="__codelineno-0-94" name="__codelineno-0-94"></a> <span class="n">docs_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="n">redoc_url</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-96" name="__codelineno-0-96"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-97" name="__codelineno-0-97"></a>
|
|
<a id="__codelineno-0-98" name="__codelineno-0-98"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_bootstrap_rest_api</span><span class="p">()</span>
|
|
<a id="__codelineno-0-99" name="__codelineno-0-99"></a>
|
|
<a id="__codelineno-0-100" name="__codelineno-0-100"></a> <span class="nd">@overload</span>
|
|
<a id="__codelineno-0-101" name="__codelineno-0-101"></a> <span class="nd">@staticmethod</span>
|
|
<a id="__codelineno-0-102" name="__codelineno-0-102"></a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span> <span class="c1"># type: ignore</span>
|
|
<a id="__codelineno-0-103" name="__codelineno-0-103"></a> <span class="c1"># Overloaded function signatures 1 and 2 overlap with incompatible return types</span>
|
|
<a id="__codelineno-0-104" name="__codelineno-0-104"></a> <span class="c1"># https://github.com/python/mypy/issues/12759</span>
|
|
<a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">V</span><span class="p">]],</span>
|
|
<a id="__codelineno-0-106" name="__codelineno-0-106"></a> <span class="p">)</span> <span class="o">-></span> <span class="s2">"GreatAI[Awaitable[Trace[V]], V]"</span><span class="p">:</span>
|
|
<a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-108" name="__codelineno-0-108"></a>
|
|
<a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="nd">@overload</span>
|
|
<a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="nd">@staticmethod</span>
|
|
<a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<a id="__codelineno-0-112" name="__codelineno-0-112"></a> <span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">V</span><span class="p">],</span>
|
|
<a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="p">)</span> <span class="o">-></span> <span class="s2">"GreatAI[Trace[V], V]"</span><span class="p">:</span>
|
|
<a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-115" name="__codelineno-0-115"></a>
|
|
<a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="nd">@staticmethod</span>
|
|
<a id="__codelineno-0-117" name="__codelineno-0-117"></a> <span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<a id="__codelineno-0-118" name="__codelineno-0-118"></a> <span class="n">func</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">V</span><span class="p">]],</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">V</span><span class="p">]],</span>
|
|
<a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="s2">"GreatAI[Awaitable[Trace[V]], V]"</span><span class="p">,</span> <span class="s2">"GreatAI[Trace[V], V]"</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="sd">"""Decorate a function by wrapping it in a GreatAI instance.</span>
|
|
<a id="__codelineno-0-121" name="__codelineno-0-121"></a>
|
|
<a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="sd"> The function can be typed, synchronous or async. If it has</span>
|
|
<a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="sd"> unwrapped parameters (parameters not affected by a</span>
|
|
<a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="sd"> [@parameter][great_ai.parameter] or [@use_model][great_ai.use_model] decorator),</span>
|
|
<a id="__codelineno-0-125" name="__codelineno-0-125"></a><span class="sd"> those will be automatically wrapped.</span>
|
|
<a id="__codelineno-0-126" name="__codelineno-0-126"></a>
|
|
<a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="sd"> The return value is replaced by a Trace (or Awaitable[Trace]),</span>
|
|
<a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="sd"> while the original return value is available under the `.output`</span>
|
|
<a id="__codelineno-0-129" name="__codelineno-0-129"></a><span class="sd"> property.</span>
|
|
<a id="__codelineno-0-130" name="__codelineno-0-130"></a>
|
|
<a id="__codelineno-0-131" name="__codelineno-0-131"></a><span class="sd"> For configuration options, see [great_ai.configure][].</span>
|
|
<a id="__codelineno-0-132" name="__codelineno-0-132"></a>
|
|
<a id="__codelineno-0-133" name="__codelineno-0-133"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-134" name="__codelineno-0-134"></a><span class="sd"> >>> @GreatAI.create</span>
|
|
<a id="__codelineno-0-135" name="__codelineno-0-135"></a><span class="sd"> ... def my_function(a):</span>
|
|
<a id="__codelineno-0-136" name="__codelineno-0-136"></a><span class="sd"> ... return a + 2</span>
|
|
<a id="__codelineno-0-137" name="__codelineno-0-137"></a><span class="sd"> >>> my_function(3).output</span>
|
|
<a id="__codelineno-0-138" name="__codelineno-0-138"></a><span class="sd"> 5</span>
|
|
<a id="__codelineno-0-139" name="__codelineno-0-139"></a>
|
|
<a id="__codelineno-0-140" name="__codelineno-0-140"></a><span class="sd"> >>> @GreatAI.create</span>
|
|
<a id="__codelineno-0-141" name="__codelineno-0-141"></a><span class="sd"> ... def my_function(a: int) -> int:</span>
|
|
<a id="__codelineno-0-142" name="__codelineno-0-142"></a><span class="sd"> ... return a + 2</span>
|
|
<a id="__codelineno-0-143" name="__codelineno-0-143"></a><span class="sd"> >>> my_function(3)</span>
|
|
<a id="__codelineno-0-144" name="__codelineno-0-144"></a><span class="sd"> Trace[int]...</span>
|
|
<a id="__codelineno-0-145" name="__codelineno-0-145"></a>
|
|
<a id="__codelineno-0-146" name="__codelineno-0-146"></a><span class="sd"> >>> my_function('3').output</span>
|
|
<a id="__codelineno-0-147" name="__codelineno-0-147"></a><span class="sd"> Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-148" name="__codelineno-0-148"></a><span class="sd"> ...</span>
|
|
<a id="__codelineno-0-149" name="__codelineno-0-149"></a><span class="sd"> TypeError: type of a must be int; got str instead</span>
|
|
<a id="__codelineno-0-150" name="__codelineno-0-150"></a>
|
|
<a id="__codelineno-0-151" name="__codelineno-0-151"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-152" name="__codelineno-0-152"></a><span class="sd"> func: The prediction function that needs to be decorated.</span>
|
|
<a id="__codelineno-0-153" name="__codelineno-0-153"></a>
|
|
<a id="__codelineno-0-154" name="__codelineno-0-154"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-155" name="__codelineno-0-155"></a><span class="sd"> A GreatAI instance wrapping `func`.</span>
|
|
<a id="__codelineno-0-156" name="__codelineno-0-156"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-157" name="__codelineno-0-157"></a>
|
|
<a id="__codelineno-0-158" name="__codelineno-0-158"></a> <span class="k">return</span> <span class="n">GreatAI</span><span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">V</span><span class="p">],</span> <span class="n">V</span><span class="p">](</span>
|
|
<a id="__codelineno-0-159" name="__codelineno-0-159"></a> <span class="n">func</span><span class="p">,</span>
|
|
<a id="__codelineno-0-160" name="__codelineno-0-160"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-161" name="__codelineno-0-161"></a>
|
|
<a id="__codelineno-0-162" name="__codelineno-0-162"></a> <span class="k">def</span> <span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-163" name="__codelineno-0-163"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped_func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-164" name="__codelineno-0-164"></a>
|
|
<a id="__codelineno-0-165" name="__codelineno-0-165"></a> <span class="nd">@overload</span>
|
|
<a id="__codelineno-0-166" name="__codelineno-0-166"></a> <span class="k">def</span> <span class="nf">process_batch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-167" name="__codelineno-0-167"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-168" name="__codelineno-0-168"></a> <span class="n">batch</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Tuple</span><span class="p">],</span>
|
|
<a id="__codelineno-0-169" name="__codelineno-0-169"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-170" name="__codelineno-0-170"></a> <span class="n">concurrency</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-171" name="__codelineno-0-171"></a> <span class="n">unpack_arguments</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="kc">True</span><span class="p">],</span>
|
|
<a id="__codelineno-0-172" name="__codelineno-0-172"></a> <span class="n">do_not_persist_traces</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span>
|
|
<a id="__codelineno-0-173" name="__codelineno-0-173"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">V</span><span class="p">]]:</span>
|
|
<a id="__codelineno-0-174" name="__codelineno-0-174"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-175" name="__codelineno-0-175"></a>
|
|
<a id="__codelineno-0-176" name="__codelineno-0-176"></a> <span class="nd">@overload</span>
|
|
<a id="__codelineno-0-177" name="__codelineno-0-177"></a> <span class="k">def</span> <span class="nf">process_batch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-178" name="__codelineno-0-178"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-179" name="__codelineno-0-179"></a> <span class="n">batch</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">,</span>
|
|
<a id="__codelineno-0-180" name="__codelineno-0-180"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-181" name="__codelineno-0-181"></a> <span class="n">concurrency</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-182" name="__codelineno-0-182"></a> <span class="n">unpack_arguments</span><span class="p">:</span> <span class="n">Literal</span><span class="p">[</span><span class="kc">False</span><span class="p">]</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span>
|
|
<a id="__codelineno-0-183" name="__codelineno-0-183"></a> <span class="n">do_not_persist_traces</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="o">...</span><span class="p">,</span>
|
|
<a id="__codelineno-0-184" name="__codelineno-0-184"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">V</span><span class="p">]]:</span>
|
|
<a id="__codelineno-0-185" name="__codelineno-0-185"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-186" name="__codelineno-0-186"></a>
|
|
<a id="__codelineno-0-187" name="__codelineno-0-187"></a> <span class="k">def</span> <span class="nf">process_batch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-188" name="__codelineno-0-188"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-189" name="__codelineno-0-189"></a> <span class="n">batch</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">,</span>
|
|
<a id="__codelineno-0-190" name="__codelineno-0-190"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-191" name="__codelineno-0-191"></a> <span class="n">concurrency</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-192" name="__codelineno-0-192"></a> <span class="n">unpack_arguments</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-193" name="__codelineno-0-193"></a> <span class="n">do_not_persist_traces</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-194" name="__codelineno-0-194"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">V</span><span class="p">]]:</span>
|
|
<a id="__codelineno-0-195" name="__codelineno-0-195"></a> <span class="sd">"""Map the wrapped function over a list of input_values (`batch`).</span>
|
|
<a id="__codelineno-0-196" name="__codelineno-0-196"></a>
|
|
<a id="__codelineno-0-197" name="__codelineno-0-197"></a><span class="sd"> A wrapper over [parallel_map][great_ai.utilities.parallel_map.parallel_map.parallel_map]</span>
|
|
<a id="__codelineno-0-198" name="__codelineno-0-198"></a><span class="sd"> providing type-safety and a progressbar through tqdm.</span>
|
|
<a id="__codelineno-0-199" name="__codelineno-0-199"></a>
|
|
<a id="__codelineno-0-200" name="__codelineno-0-200"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-201" name="__codelineno-0-201"></a><span class="sd"> batch: A list of arguments for the original (wrapped) function. If the</span>
|
|
<a id="__codelineno-0-202" name="__codelineno-0-202"></a><span class="sd"> function expects multiple arguments, provide a list of tuples and set</span>
|
|
<a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="sd"> `unpack_arguments=True`.</span>
|
|
<a id="__codelineno-0-204" name="__codelineno-0-204"></a><span class="sd"> concurrency: Number of processes to start. Don't set it too much higher than</span>
|
|
<a id="__codelineno-0-205" name="__codelineno-0-205"></a><span class="sd"> the number of available CPU cores.</span>
|
|
<a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd"> unpack_arguments: Expect a list of tuples and unpack the tuples before</span>
|
|
<a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd"> giving them to the wrapped function.</span>
|
|
<a id="__codelineno-0-208" name="__codelineno-0-208"></a><span class="sd"> do_not_persist_traces: Don't save the traces in the database. Useful for</span>
|
|
<a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd"> evaluations run part of the CI.</span>
|
|
<a id="__codelineno-0-210" name="__codelineno-0-210"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-211" name="__codelineno-0-211"></a>
|
|
<a id="__codelineno-0-212" name="__codelineno-0-212"></a> <span class="n">wrapped_function</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped_func</span>
|
|
<a id="__codelineno-0-213" name="__codelineno-0-213"></a>
|
|
<a id="__codelineno-0-214" name="__codelineno-0-214"></a> <span class="k">def</span> <span class="nf">inner</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-215" name="__codelineno-0-215"></a> <span class="k">return</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-216" name="__codelineno-0-216"></a> <span class="n">wrapped_function</span><span class="p">(</span><span class="o">*</span><span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span><span class="p">)</span>
|
|
<a id="__codelineno-0-217" name="__codelineno-0-217"></a> <span class="k">if</span> <span class="n">unpack_arguments</span>
|
|
<a id="__codelineno-0-218" name="__codelineno-0-218"></a> <span class="k">else</span> <span class="n">wrapped_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-219" name="__codelineno-0-219"></a> <span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-220" name="__codelineno-0-220"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-221" name="__codelineno-0-221"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-222" name="__codelineno-0-222"></a>
|
|
<a id="__codelineno-0-223" name="__codelineno-0-223"></a> <span class="k">async</span> <span class="k">def</span> <span class="nf">inner_async</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-224" name="__codelineno-0-224"></a> <span class="k">return</span> <span class="k">await</span> <span class="n">cast</span><span class="p">(</span>
|
|
<a id="__codelineno-0-225" name="__codelineno-0-225"></a> <span class="n">Awaitable</span><span class="p">,</span>
|
|
<a id="__codelineno-0-226" name="__codelineno-0-226"></a> <span class="p">(</span>
|
|
<a id="__codelineno-0-227" name="__codelineno-0-227"></a> <span class="n">wrapped_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-228" name="__codelineno-0-228"></a> <span class="o">*</span><span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-229" name="__codelineno-0-229"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-230" name="__codelineno-0-230"></a> <span class="k">if</span> <span class="n">unpack_arguments</span>
|
|
<a id="__codelineno-0-231" name="__codelineno-0-231"></a> <span class="k">else</span> <span class="n">wrapped_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-232" name="__codelineno-0-232"></a> <span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-233" name="__codelineno-0-233"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-234" name="__codelineno-0-234"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-235" name="__codelineno-0-235"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-236" name="__codelineno-0-236"></a>
|
|
<a id="__codelineno-0-237" name="__codelineno-0-237"></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span>
|
|
<a id="__codelineno-0-238" name="__codelineno-0-238"></a> <span class="n">tqdm</span><span class="p">(</span>
|
|
<a id="__codelineno-0-239" name="__codelineno-0-239"></a> <span class="n">parallel_map</span><span class="p">(</span>
|
|
<a id="__codelineno-0-240" name="__codelineno-0-240"></a> <span class="n">inner_async</span>
|
|
<a id="__codelineno-0-241" name="__codelineno-0-241"></a> <span class="k">if</span> <span class="n">get_function_metadata_store</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">is_asynchronous</span>
|
|
<a id="__codelineno-0-242" name="__codelineno-0-242"></a> <span class="k">else</span> <span class="n">inner</span><span class="p">,</span>
|
|
<a id="__codelineno-0-243" name="__codelineno-0-243"></a> <span class="n">batch</span><span class="p">,</span>
|
|
<a id="__codelineno-0-244" name="__codelineno-0-244"></a> <span class="n">concurrency</span><span class="o">=</span><span class="n">concurrency</span><span class="p">,</span>
|
|
<a id="__codelineno-0-245" name="__codelineno-0-245"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-246" name="__codelineno-0-246"></a> <span class="n">total</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">batch</span><span class="p">),</span>
|
|
<a id="__codelineno-0-247" name="__codelineno-0-247"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-248" name="__codelineno-0-248"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-249" name="__codelineno-0-249"></a>
|
|
<a id="__codelineno-0-250" name="__codelineno-0-250"></a> <span class="nd">@staticmethod</span>
|
|
<a id="__codelineno-0-251" name="__codelineno-0-251"></a> <span class="k">def</span> <span class="nf">_get_cached_traced_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-252" name="__codelineno-0-252"></a> <span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Union</span><span class="p">[</span><span class="n">V</span><span class="p">,</span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">V</span><span class="p">]]]</span>
|
|
<a id="__codelineno-0-253" name="__codelineno-0-253"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-254" name="__codelineno-0-254"></a> <span class="nd">@lru_cache</span><span class="p">(</span><span class="n">maxsize</span><span class="o">=</span><span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">prediction_cache_size</span><span class="p">)</span>
|
|
<a id="__codelineno-0-255" name="__codelineno-0-255"></a> <span class="k">def</span> <span class="nf">func_in_tracing_context_sync</span><span class="p">(</span>
|
|
<a id="__codelineno-0-256" name="__codelineno-0-256"></a> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
|
|
<a id="__codelineno-0-257" name="__codelineno-0-257"></a> <span class="n">do_not_persist_traces</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-258" name="__codelineno-0-258"></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
|
|
<a id="__codelineno-0-259" name="__codelineno-0-259"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-260" name="__codelineno-0-260"></a> <span class="k">with</span> <span class="n">TracingContext</span><span class="p">[</span><span class="n">V</span><span class="p">](</span>
|
|
<a id="__codelineno-0-261" name="__codelineno-0-261"></a> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-262" name="__codelineno-0-262"></a> <span class="p">)</span> <span class="k">as</span> <span class="n">t</span><span class="p">:</span>
|
|
<a id="__codelineno-0-263" name="__codelineno-0-263"></a> <span class="n">result</span> <span class="o">=</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-264" name="__codelineno-0-264"></a> <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="n">T</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">finalise</span><span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="n">result</span><span class="p">))</span>
|
|
<a id="__codelineno-0-265" name="__codelineno-0-265"></a>
|
|
<a id="__codelineno-0-266" name="__codelineno-0-266"></a> <span class="nd">@alru_cache</span><span class="p">(</span><span class="n">maxsize</span><span class="o">=</span><span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">prediction_cache_size</span><span class="p">)</span>
|
|
<a id="__codelineno-0-267" name="__codelineno-0-267"></a> <span class="k">async</span> <span class="k">def</span> <span class="nf">func_in_tracing_context_async</span><span class="p">(</span>
|
|
<a id="__codelineno-0-268" name="__codelineno-0-268"></a> <span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
|
|
<a id="__codelineno-0-269" name="__codelineno-0-269"></a> <span class="n">do_not_persist_traces</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-270" name="__codelineno-0-270"></a> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
|
|
<a id="__codelineno-0-271" name="__codelineno-0-271"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-272" name="__codelineno-0-272"></a> <span class="k">with</span> <span class="n">TracingContext</span><span class="p">[</span><span class="n">V</span><span class="p">](</span>
|
|
<a id="__codelineno-0-273" name="__codelineno-0-273"></a> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-274" name="__codelineno-0-274"></a> <span class="p">)</span> <span class="k">as</span> <span class="n">t</span><span class="p">:</span>
|
|
<a id="__codelineno-0-275" name="__codelineno-0-275"></a> <span class="n">result</span> <span class="o">=</span> <span class="k">await</span> <span class="n">cast</span><span class="p">(</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Awaitable</span><span class="p">],</span> <span class="n">func</span><span class="p">)(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-276" name="__codelineno-0-276"></a> <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="n">T</span><span class="p">,</span> <span class="n">t</span><span class="o">.</span><span class="n">finalise</span><span class="p">(</span><span class="n">output</span><span class="o">=</span><span class="n">result</span><span class="p">))</span>
|
|
<a id="__codelineno-0-277" name="__codelineno-0-277"></a>
|
|
<a id="__codelineno-0-278" name="__codelineno-0-278"></a> <span class="k">return</span> <span class="n">cast</span><span class="p">(</span>
|
|
<a id="__codelineno-0-279" name="__codelineno-0-279"></a> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">T</span><span class="p">],</span>
|
|
<a id="__codelineno-0-280" name="__codelineno-0-280"></a> <span class="p">(</span>
|
|
<a id="__codelineno-0-281" name="__codelineno-0-281"></a> <span class="n">func_in_tracing_context_async</span>
|
|
<a id="__codelineno-0-282" name="__codelineno-0-282"></a> <span class="k">if</span> <span class="n">get_function_metadata_store</span><span class="p">(</span><span class="n">func</span><span class="p">)</span><span class="o">.</span><span class="n">is_asynchronous</span>
|
|
<a id="__codelineno-0-283" name="__codelineno-0-283"></a> <span class="k">else</span> <span class="n">func_in_tracing_context_sync</span>
|
|
<a id="__codelineno-0-284" name="__codelineno-0-284"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-285" name="__codelineno-0-285"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-286" name="__codelineno-0-286"></a>
|
|
<a id="__codelineno-0-287" name="__codelineno-0-287"></a> <span class="k">def</span> <span class="nf">_bootstrap_rest_api</span><span class="p">(</span>
|
|
<a id="__codelineno-0-288" name="__codelineno-0-288"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-289" name="__codelineno-0-289"></a> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-290" name="__codelineno-0-290"></a> <span class="n">route_config</span> <span class="o">=</span> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">route_config</span>
|
|
<a id="__codelineno-0-291" name="__codelineno-0-291"></a>
|
|
<a id="__codelineno-0-292" name="__codelineno-0-292"></a> <span class="k">if</span> <span class="n">route_config</span><span class="o">.</span><span class="n">prediction_endpoint_enabled</span><span class="p">:</span>
|
|
<a id="__codelineno-0-293" name="__codelineno-0-293"></a> <span class="n">bootstrap_prediction_endpoint</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped_func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-294" name="__codelineno-0-294"></a>
|
|
<a id="__codelineno-0-295" name="__codelineno-0-295"></a> <span class="k">if</span> <span class="n">route_config</span><span class="o">.</span><span class="n">docs_endpoints_enabled</span><span class="p">:</span>
|
|
<a id="__codelineno-0-296" name="__codelineno-0-296"></a> <span class="n">bootstrap_docs_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">)</span>
|
|
<a id="__codelineno-0-297" name="__codelineno-0-297"></a>
|
|
<a id="__codelineno-0-298" name="__codelineno-0-298"></a> <span class="k">if</span> <span class="n">route_config</span><span class="o">.</span><span class="n">dashboard_enabled</span><span class="p">:</span>
|
|
<a id="__codelineno-0-299" name="__codelineno-0-299"></a> <span class="n">bootstrap_dashboard</span><span class="p">(</span>
|
|
<a id="__codelineno-0-300" name="__codelineno-0-300"></a> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">,</span>
|
|
<a id="__codelineno-0-301" name="__codelineno-0-301"></a> <span class="n">function_name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
|
|
<a id="__codelineno-0-302" name="__codelineno-0-302"></a> <span class="n">documentation</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">,</span>
|
|
<a id="__codelineno-0-303" name="__codelineno-0-303"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-304" name="__codelineno-0-304"></a>
|
|
<a id="__codelineno-0-305" name="__codelineno-0-305"></a> <span class="k">if</span> <span class="n">route_config</span><span class="o">.</span><span class="n">trace_endpoints_enabled</span><span class="p">:</span>
|
|
<a id="__codelineno-0-306" name="__codelineno-0-306"></a> <span class="n">bootstrap_trace_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">)</span>
|
|
<a id="__codelineno-0-307" name="__codelineno-0-307"></a>
|
|
<a id="__codelineno-0-308" name="__codelineno-0-308"></a> <span class="k">if</span> <span class="n">route_config</span><span class="o">.</span><span class="n">feedback_endpoints_enabled</span><span class="p">:</span>
|
|
<a id="__codelineno-0-309" name="__codelineno-0-309"></a> <span class="n">bootstrap_feedback_endpoints</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">)</span>
|
|
<a id="__codelineno-0-310" name="__codelineno-0-310"></a>
|
|
<a id="__codelineno-0-311" name="__codelineno-0-311"></a> <span class="k">if</span> <span class="n">route_config</span><span class="o">.</span><span class="n">meta_endpoints_enabled</span><span class="p">:</span>
|
|
<a id="__codelineno-0-312" name="__codelineno-0-312"></a> <span class="n">bootstrap_meta_endpoints</span><span class="p">(</span>
|
|
<a id="__codelineno-0-313" name="__codelineno-0-313"></a> <span class="bp">self</span><span class="o">.</span><span class="n">app</span><span class="p">,</span>
|
|
<a id="__codelineno-0-314" name="__codelineno-0-314"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_cached_func</span><span class="p">,</span>
|
|
<a id="__codelineno-0-315" name="__codelineno-0-315"></a> <span class="n">ApiMetadata</span><span class="p">(</span>
|
|
<a id="__codelineno-0-316" name="__codelineno-0-316"></a> <span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__name__</span><span class="p">,</span>
|
|
<a id="__codelineno-0-317" name="__codelineno-0-317"></a> <span class="n">version</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">,</span>
|
|
<a id="__codelineno-0-318" name="__codelineno-0-318"></a> <span class="n">documentation</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="vm">__doc__</span><span class="p">,</span>
|
|
<a id="__codelineno-0-319" name="__codelineno-0-319"></a> <span class="n">configuration</span><span class="o">=</span><span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">to_flat_dict</span><span class="p">(),</span>
|
|
<a id="__codelineno-0-320" name="__codelineno-0-320"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-321" name="__codelineno-0-321"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h4 id="great_ai.deploy.great_ai.GreatAI.create" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">create</span><span class="p">(</span><span class="n">func</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
|
|
</span>
|
|
|
|
<a href="#great_ai.deploy.great_ai.GreatAI.create" class="headerlink" title="Permanent link">#</a></h4>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Decorate a function by wrapping it in a GreatAI instance.</p>
|
|
<p>The function can be typed, synchronous or async. If it has
|
|
unwrapped parameters (parameters not affected by a
|
|
<a class="autorefs autorefs-internal" href="#great_ai.parameter">@parameter</a> or <a class="autorefs autorefs-internal" href="#great_ai.use_model">@use_model</a> decorator),
|
|
those will be automatically wrapped.</p>
|
|
<p>The return value is replaced by a Trace (or Awaitable[Trace]),
|
|
while the original return value is available under the <code>.output</code>
|
|
property.</p>
|
|
<p>For configuration options, see <a class="autorefs autorefs-internal" href="#great_ai.configure">great_ai.configure</a>.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="nd">@GreatAI</span><span class="o">.</span><span class="n">create</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">a</span><span class="p">):</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="mi">2</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span><span class="o">.</span><span class="n">output</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="go">5</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="nd">@GreatAI</span><span class="o">.</span><span class="n">create</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="mi">2</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="go">Trace[int]...</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="s1">'3'</span><span class="p">)</span><span class="o">.</span><span class="n">output</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gt">Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gr">TypeError</span>: <span class="n">type of a must be int; got str instead</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>func</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[<span title="typing.Callable">Callable</span>[..., <span title="typing.Awaitable">Awaitable</span>[<span title="great_ai.deploy.great_ai.V">V</span>]], <span title="typing.Callable">Callable</span>[..., <span title="great_ai.deploy.great_ai.V">V</span>]]</code>
|
|
</td>
|
|
<td><p>The prediction function that needs to be decorated.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[GreatAI[Awaitable[Trace[V]], V], GreatAI[Trace[V], V]]</code>
|
|
</td>
|
|
<td><p>A GreatAI instance wrapping <code>func</code>.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/deploy/great_ai.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-116">116</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-117">117</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-119">119</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-120">120</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-121">121</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-122">122</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-123">123</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-124">124</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-125">125</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-126">126</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-127">127</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-128">128</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-129">129</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-130">130</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-131">131</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-132">132</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-133">133</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-134">134</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-135">135</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-136">136</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-137">137</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-138">138</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-139">139</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-140">140</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-141">141</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-142">142</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-143">143</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-144">144</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-145">145</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-150">150</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-151">151</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-152">152</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-153">153</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-154">154</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-155">155</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-157">157</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-158">158</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-159">159</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-160">160</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-116" name="__codelineno-0-116"></a><span class="nd">@staticmethod</span>
|
|
<a id="__codelineno-0-117" name="__codelineno-0-117"></a><span class="k">def</span> <span class="nf">create</span><span class="p">(</span>
|
|
<a id="__codelineno-0-118" name="__codelineno-0-118"></a> <span class="n">func</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">Awaitable</span><span class="p">[</span><span class="n">V</span><span class="p">]],</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">V</span><span class="p">]],</span>
|
|
<a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Union</span><span class="p">[</span><span class="s2">"GreatAI[Awaitable[Trace[V]], V]"</span><span class="p">,</span> <span class="s2">"GreatAI[Trace[V], V]"</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="sd">"""Decorate a function by wrapping it in a GreatAI instance.</span>
|
|
<a id="__codelineno-0-121" name="__codelineno-0-121"></a>
|
|
<a id="__codelineno-0-122" name="__codelineno-0-122"></a><span class="sd"> The function can be typed, synchronous or async. If it has</span>
|
|
<a id="__codelineno-0-123" name="__codelineno-0-123"></a><span class="sd"> unwrapped parameters (parameters not affected by a</span>
|
|
<a id="__codelineno-0-124" name="__codelineno-0-124"></a><span class="sd"> [@parameter][great_ai.parameter] or [@use_model][great_ai.use_model] decorator),</span>
|
|
<a id="__codelineno-0-125" name="__codelineno-0-125"></a><span class="sd"> those will be automatically wrapped.</span>
|
|
<a id="__codelineno-0-126" name="__codelineno-0-126"></a>
|
|
<a id="__codelineno-0-127" name="__codelineno-0-127"></a><span class="sd"> The return value is replaced by a Trace (or Awaitable[Trace]),</span>
|
|
<a id="__codelineno-0-128" name="__codelineno-0-128"></a><span class="sd"> while the original return value is available under the `.output`</span>
|
|
<a id="__codelineno-0-129" name="__codelineno-0-129"></a><span class="sd"> property.</span>
|
|
<a id="__codelineno-0-130" name="__codelineno-0-130"></a>
|
|
<a id="__codelineno-0-131" name="__codelineno-0-131"></a><span class="sd"> For configuration options, see [great_ai.configure][].</span>
|
|
<a id="__codelineno-0-132" name="__codelineno-0-132"></a>
|
|
<a id="__codelineno-0-133" name="__codelineno-0-133"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-134" name="__codelineno-0-134"></a><span class="sd"> >>> @GreatAI.create</span>
|
|
<a id="__codelineno-0-135" name="__codelineno-0-135"></a><span class="sd"> ... def my_function(a):</span>
|
|
<a id="__codelineno-0-136" name="__codelineno-0-136"></a><span class="sd"> ... return a + 2</span>
|
|
<a id="__codelineno-0-137" name="__codelineno-0-137"></a><span class="sd"> >>> my_function(3).output</span>
|
|
<a id="__codelineno-0-138" name="__codelineno-0-138"></a><span class="sd"> 5</span>
|
|
<a id="__codelineno-0-139" name="__codelineno-0-139"></a>
|
|
<a id="__codelineno-0-140" name="__codelineno-0-140"></a><span class="sd"> >>> @GreatAI.create</span>
|
|
<a id="__codelineno-0-141" name="__codelineno-0-141"></a><span class="sd"> ... def my_function(a: int) -> int:</span>
|
|
<a id="__codelineno-0-142" name="__codelineno-0-142"></a><span class="sd"> ... return a + 2</span>
|
|
<a id="__codelineno-0-143" name="__codelineno-0-143"></a><span class="sd"> >>> my_function(3)</span>
|
|
<a id="__codelineno-0-144" name="__codelineno-0-144"></a><span class="sd"> Trace[int]...</span>
|
|
<a id="__codelineno-0-145" name="__codelineno-0-145"></a>
|
|
<a id="__codelineno-0-146" name="__codelineno-0-146"></a><span class="sd"> >>> my_function('3').output</span>
|
|
<a id="__codelineno-0-147" name="__codelineno-0-147"></a><span class="sd"> Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-148" name="__codelineno-0-148"></a><span class="sd"> ...</span>
|
|
<a id="__codelineno-0-149" name="__codelineno-0-149"></a><span class="sd"> TypeError: type of a must be int; got str instead</span>
|
|
<a id="__codelineno-0-150" name="__codelineno-0-150"></a>
|
|
<a id="__codelineno-0-151" name="__codelineno-0-151"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-152" name="__codelineno-0-152"></a><span class="sd"> func: The prediction function that needs to be decorated.</span>
|
|
<a id="__codelineno-0-153" name="__codelineno-0-153"></a>
|
|
<a id="__codelineno-0-154" name="__codelineno-0-154"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-155" name="__codelineno-0-155"></a><span class="sd"> A GreatAI instance wrapping `func`.</span>
|
|
<a id="__codelineno-0-156" name="__codelineno-0-156"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-157" name="__codelineno-0-157"></a>
|
|
<a id="__codelineno-0-158" name="__codelineno-0-158"></a> <span class="k">return</span> <span class="n">GreatAI</span><span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">V</span><span class="p">],</span> <span class="n">V</span><span class="p">](</span>
|
|
<a id="__codelineno-0-159" name="__codelineno-0-159"></a> <span class="n">func</span><span class="p">,</span>
|
|
<a id="__codelineno-0-160" name="__codelineno-0-160"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h4 id="great_ai.deploy.great_ai.GreatAI.process_batch" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">process_batch</span><span class="p">(</span><span class="n">batch</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">concurrency</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">unpack_arguments</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.deploy.great_ai.GreatAI.process_batch" class="headerlink" title="Permanent link">#</a></h4>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Map the wrapped function over a list of input_values (<code>batch</code>).</p>
|
|
<p>A wrapper over <a class="autorefs autorefs-internal" href="utilities/#great_ai.utilities.parallel_map.parallel_map.parallel_map">parallel_map</a>
|
|
providing type-safety and a progressbar through tqdm.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>batch</code></td>
|
|
<td>
|
|
<code><span title="typing.Sequence">Sequence</span></code>
|
|
</td>
|
|
<td><p>A list of arguments for the original (wrapped) function. If the
|
|
function expects multiple arguments, provide a list of tuples and set
|
|
<code>unpack_arguments=True</code>.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>concurrency</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[int]</code>
|
|
</td>
|
|
<td><p>Number of processes to start. Don't set it too much higher than
|
|
the number of available CPU cores.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>unpack_arguments</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td><p>Expect a list of tuples and unpack the tuples before
|
|
giving them to the wrapped function.</p></td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>do_not_persist_traces</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td><p>Don't save the traces in the database. Useful for
|
|
evaluations run part of the CI.</p></td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/deploy/great_ai.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-187">187</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-188">188</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-189">189</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-190">190</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-191">191</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-192">192</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-193">193</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-194">194</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-195">195</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-196">196</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-197">197</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-198">198</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-199">199</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-200">200</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-201">201</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-202">202</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-203">203</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-204">204</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-205">205</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-206">206</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-207">207</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-208">208</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-209">209</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-210">210</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-211">211</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-212">212</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-213">213</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-214">214</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-215">215</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-216">216</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-217">217</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-218">218</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-219">219</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-220">220</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-221">221</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-222">222</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-223">223</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-224">224</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-225">225</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-226">226</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-227">227</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-228">228</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-229">229</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-230">230</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-231">231</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-232">232</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-233">233</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-234">234</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-235">235</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-236">236</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-237">237</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-238">238</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-239">239</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-240">240</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-241">241</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-242">242</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-243">243</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-244">244</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-245">245</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-246">246</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-247">247</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-248">248</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-187" name="__codelineno-0-187"></a><span class="k">def</span> <span class="nf">process_batch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-188" name="__codelineno-0-188"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-189" name="__codelineno-0-189"></a> <span class="n">batch</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">,</span>
|
|
<a id="__codelineno-0-190" name="__codelineno-0-190"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-191" name="__codelineno-0-191"></a> <span class="n">concurrency</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-192" name="__codelineno-0-192"></a> <span class="n">unpack_arguments</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-193" name="__codelineno-0-193"></a> <span class="n">do_not_persist_traces</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-194" name="__codelineno-0-194"></a><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">V</span><span class="p">]]:</span>
|
|
<a id="__codelineno-0-195" name="__codelineno-0-195"></a> <span class="sd">"""Map the wrapped function over a list of input_values (`batch`).</span>
|
|
<a id="__codelineno-0-196" name="__codelineno-0-196"></a>
|
|
<a id="__codelineno-0-197" name="__codelineno-0-197"></a><span class="sd"> A wrapper over [parallel_map][great_ai.utilities.parallel_map.parallel_map.parallel_map]</span>
|
|
<a id="__codelineno-0-198" name="__codelineno-0-198"></a><span class="sd"> providing type-safety and a progressbar through tqdm.</span>
|
|
<a id="__codelineno-0-199" name="__codelineno-0-199"></a>
|
|
<a id="__codelineno-0-200" name="__codelineno-0-200"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-201" name="__codelineno-0-201"></a><span class="sd"> batch: A list of arguments for the original (wrapped) function. If the</span>
|
|
<a id="__codelineno-0-202" name="__codelineno-0-202"></a><span class="sd"> function expects multiple arguments, provide a list of tuples and set</span>
|
|
<a id="__codelineno-0-203" name="__codelineno-0-203"></a><span class="sd"> `unpack_arguments=True`.</span>
|
|
<a id="__codelineno-0-204" name="__codelineno-0-204"></a><span class="sd"> concurrency: Number of processes to start. Don't set it too much higher than</span>
|
|
<a id="__codelineno-0-205" name="__codelineno-0-205"></a><span class="sd"> the number of available CPU cores.</span>
|
|
<a id="__codelineno-0-206" name="__codelineno-0-206"></a><span class="sd"> unpack_arguments: Expect a list of tuples and unpack the tuples before</span>
|
|
<a id="__codelineno-0-207" name="__codelineno-0-207"></a><span class="sd"> giving them to the wrapped function.</span>
|
|
<a id="__codelineno-0-208" name="__codelineno-0-208"></a><span class="sd"> do_not_persist_traces: Don't save the traces in the database. Useful for</span>
|
|
<a id="__codelineno-0-209" name="__codelineno-0-209"></a><span class="sd"> evaluations run part of the CI.</span>
|
|
<a id="__codelineno-0-210" name="__codelineno-0-210"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-211" name="__codelineno-0-211"></a>
|
|
<a id="__codelineno-0-212" name="__codelineno-0-212"></a> <span class="n">wrapped_function</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_wrapped_func</span>
|
|
<a id="__codelineno-0-213" name="__codelineno-0-213"></a>
|
|
<a id="__codelineno-0-214" name="__codelineno-0-214"></a> <span class="k">def</span> <span class="nf">inner</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-215" name="__codelineno-0-215"></a> <span class="k">return</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-216" name="__codelineno-0-216"></a> <span class="n">wrapped_function</span><span class="p">(</span><span class="o">*</span><span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span><span class="p">)</span>
|
|
<a id="__codelineno-0-217" name="__codelineno-0-217"></a> <span class="k">if</span> <span class="n">unpack_arguments</span>
|
|
<a id="__codelineno-0-218" name="__codelineno-0-218"></a> <span class="k">else</span> <span class="n">wrapped_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-219" name="__codelineno-0-219"></a> <span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-220" name="__codelineno-0-220"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-221" name="__codelineno-0-221"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-222" name="__codelineno-0-222"></a>
|
|
<a id="__codelineno-0-223" name="__codelineno-0-223"></a> <span class="k">async</span> <span class="k">def</span> <span class="nf">inner_async</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="n">T</span><span class="p">:</span>
|
|
<a id="__codelineno-0-224" name="__codelineno-0-224"></a> <span class="k">return</span> <span class="k">await</span> <span class="n">cast</span><span class="p">(</span>
|
|
<a id="__codelineno-0-225" name="__codelineno-0-225"></a> <span class="n">Awaitable</span><span class="p">,</span>
|
|
<a id="__codelineno-0-226" name="__codelineno-0-226"></a> <span class="p">(</span>
|
|
<a id="__codelineno-0-227" name="__codelineno-0-227"></a> <span class="n">wrapped_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-228" name="__codelineno-0-228"></a> <span class="o">*</span><span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-229" name="__codelineno-0-229"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-230" name="__codelineno-0-230"></a> <span class="k">if</span> <span class="n">unpack_arguments</span>
|
|
<a id="__codelineno-0-231" name="__codelineno-0-231"></a> <span class="k">else</span> <span class="n">wrapped_function</span><span class="p">(</span>
|
|
<a id="__codelineno-0-232" name="__codelineno-0-232"></a> <span class="n">value</span><span class="p">,</span> <span class="n">do_not_persist_traces</span><span class="o">=</span><span class="n">do_not_persist_traces</span>
|
|
<a id="__codelineno-0-233" name="__codelineno-0-233"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-234" name="__codelineno-0-234"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-235" name="__codelineno-0-235"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-236" name="__codelineno-0-236"></a>
|
|
<a id="__codelineno-0-237" name="__codelineno-0-237"></a> <span class="k">return</span> <span class="nb">list</span><span class="p">(</span>
|
|
<a id="__codelineno-0-238" name="__codelineno-0-238"></a> <span class="n">tqdm</span><span class="p">(</span>
|
|
<a id="__codelineno-0-239" name="__codelineno-0-239"></a> <span class="n">parallel_map</span><span class="p">(</span>
|
|
<a id="__codelineno-0-240" name="__codelineno-0-240"></a> <span class="n">inner_async</span>
|
|
<a id="__codelineno-0-241" name="__codelineno-0-241"></a> <span class="k">if</span> <span class="n">get_function_metadata_store</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span><span class="o">.</span><span class="n">is_asynchronous</span>
|
|
<a id="__codelineno-0-242" name="__codelineno-0-242"></a> <span class="k">else</span> <span class="n">inner</span><span class="p">,</span>
|
|
<a id="__codelineno-0-243" name="__codelineno-0-243"></a> <span class="n">batch</span><span class="p">,</span>
|
|
<a id="__codelineno-0-244" name="__codelineno-0-244"></a> <span class="n">concurrency</span><span class="o">=</span><span class="n">concurrency</span><span class="p">,</span>
|
|
<a id="__codelineno-0-245" name="__codelineno-0-245"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-246" name="__codelineno-0-246"></a> <span class="n">total</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">batch</span><span class="p">),</span>
|
|
<a id="__codelineno-0-247" name="__codelineno-0-247"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-248" name="__codelineno-0-248"></a> <span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.configure" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">configure</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s1">'0.0.1'</span><span class="p">,</span> <span class="n">log_level</span><span class="o">=</span><span class="n">DEBUG</span><span class="p">,</span> <span class="n">seed</span><span class="o">=</span><span class="mi">42</span><span class="p">,</span> <span class="n">tracing_database_factory</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">large_file_implementation</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">should_log_exception_stack</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">prediction_cache_size</span><span class="o">=</span><span class="mi">512</span><span class="p">,</span> <span class="n">disable_se4ml_banner</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">dashboard_table_size</span><span class="o">=</span><span class="mi">50</span><span class="p">,</span> <span class="n">route_config</span><span class="o">=</span><span class="n">RouteConfig</span><span class="p">())</span></code>
|
|
|
|
<a href="#great_ai.configure" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Set the global configuration used by the great-ai library.</p>
|
|
<p>You must call <code>configure</code> before calling (or decorating with) any other great-ai
|
|
function.</p>
|
|
<p>If <code>tracing_database_factory</code> or <code>large_file_implementation</code> is not specified, their
|
|
default value is determined based on which TracingDatabase and LargeFile has been
|
|
configured (e.g.: LargeFileS3.configure_credentials_from_file('s3.ini')), or whether
|
|
there is any file named s3.ini or mongo.ini in the working directory.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="n">configure</span><span class="p">(</span><span class="n">prediction_cache_size</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>version</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[int, str]</code>
|
|
</td>
|
|
<td><p>The version of your application (using SemVer is recommended).</p></td>
|
|
<td>
|
|
<code>'0.0.1'</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>log_level</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td><p>Set the default logging level of <code>logging</code>.</p></td>
|
|
<td>
|
|
<code>DEBUG</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>seed</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td><p>Set seed of <code>random</code> (and <code>numpy</code> if installed) for reproducibility.</p></td>
|
|
<td>
|
|
<code>42</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tracing_database_factory</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="typing.Type">Type</span>[<a class="autorefs autorefs-internal" title="great_ai.persistence.tracing_database_driver.TracingDatabaseDriver" href="#great_ai.TracingDatabaseDriver">TracingDatabaseDriver</a>]]</code>
|
|
</td>
|
|
<td><p>Specify a different TracingDatabaseDriver than the one
|
|
already configured.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>large_file_implementation</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="typing.Type">Type</span>[<a class="autorefs autorefs-internal" title="great_ai.large_file.LargeFileBase" href="large-file/#great_ai.large_file.LargeFileBase">LargeFileBase</a>]]</code>
|
|
</td>
|
|
<td><p>Specify a different LargeFile than the one already
|
|
configured.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>should_log_exception_stack</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[bool]</code>
|
|
</td>
|
|
<td><p>Log the traces of unhandled exceptions.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>prediction_cache_size</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td><p>Size of the LRU cache applied over the prediction
|
|
functions.</p></td>
|
|
<td>
|
|
<code>512</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>disable_se4ml_banner</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td><p>Turn off the warning about the importance of SE4ML best-
|
|
practices.</p></td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>dashboard_table_size</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td><p>Number of rows to display in the dashboard's table.</p></td>
|
|
<td>
|
|
<code>50</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>route_config</code></td>
|
|
<td>
|
|
<code><a class="autorefs autorefs-internal" title="great_ai.views.RouteConfig" href="views/#great_ai.RouteConfig">RouteConfig</a></code>
|
|
</td>
|
|
<td><p>Enable or disable specific HTTP API endpoints.</p></td>
|
|
<td>
|
|
<code>RouteConfig()</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/context.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-61"> 61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62"> 62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63"> 63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64"> 64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65"> 65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66"> 66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67"> 67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68"> 68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69"> 69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70"> 70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71"> 71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72"> 72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73"> 73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74"> 74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75"> 75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76"> 76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77"> 77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78"> 78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79"> 79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80"> 80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81"> 81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82"> 82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83"> 83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84"> 84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85"> 85</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-86"> 86</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-87"> 87</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-88"> 88</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-89"> 89</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-90"> 90</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-91"> 91</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-92"> 92</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-93"> 93</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-114">114</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-116">116</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-117">117</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-119">119</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-120">120</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-121">121</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-122">122</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-123">123</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-124">124</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-125">125</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-126">126</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-127">127</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-128">128</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-129">129</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-130">130</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-131">131</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-132">132</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-133">133</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-134">134</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-135">135</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-136">136</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-137">137</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-138">138</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-139">139</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-140">140</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-141">141</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-142">142</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-143">143</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-144">144</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-145">145</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-150">150</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-151">151</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-152">152</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-153">153</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-154">154</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-155">155</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-157">157</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="k">def</span> <span class="nf">configure</span><span class="p">(</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="n">version</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"0.0.1"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a> <span class="n">log_level</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">DEBUG</span><span class="p">,</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="n">seed</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">42</span><span class="p">,</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="n">tracing_database_factory</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">TracingDatabaseDriver</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="n">large_file_implementation</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">LargeFileBase</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="n">should_log_exception_stack</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="n">prediction_cache_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">512</span><span class="p">,</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="n">disable_se4ml_banner</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="n">dashboard_table_size</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">50</span><span class="p">,</span>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="n">route_config</span><span class="p">:</span> <span class="n">RouteConfig</span> <span class="o">=</span> <span class="n">RouteConfig</span><span class="p">(),</span>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="sd">"""Set the global configuration used by the great-ai library.</span>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a><span class="sd"> You must call `configure` before calling (or decorating with) any other great-ai</span>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a><span class="sd"> function.</span>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a><span class="sd"> If `tracing_database_factory` or `large_file_implementation` is not specified, their</span>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a><span class="sd"> default value is determined based on which TracingDatabase and LargeFile has been</span>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a><span class="sd"> configured (e.g.: LargeFileS3.configure_credentials_from_file('s3.ini')), or whether</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a><span class="sd"> there is any file named s3.ini or mongo.ini in the working directory.</span>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a><span class="sd"> >>> configure(prediction_cache_size=0)</span>
|
|
<a id="__codelineno-0-86" name="__codelineno-0-86"></a>
|
|
<a id="__codelineno-0-87" name="__codelineno-0-87"></a><span class="sd"> Arguments:</span>
|
|
<a id="__codelineno-0-88" name="__codelineno-0-88"></a><span class="sd"> version: The version of your application (using SemVer is recommended).</span>
|
|
<a id="__codelineno-0-89" name="__codelineno-0-89"></a><span class="sd"> log_level: Set the default logging level of `logging`.</span>
|
|
<a id="__codelineno-0-90" name="__codelineno-0-90"></a><span class="sd"> seed: Set seed of `random` (and `numpy` if installed) for reproducibility.</span>
|
|
<a id="__codelineno-0-91" name="__codelineno-0-91"></a><span class="sd"> tracing_database_factory: Specify a different TracingDatabaseDriver than the one</span>
|
|
<a id="__codelineno-0-92" name="__codelineno-0-92"></a><span class="sd"> already configured.</span>
|
|
<a id="__codelineno-0-93" name="__codelineno-0-93"></a><span class="sd"> large_file_implementation: Specify a different LargeFile than the one already</span>
|
|
<a id="__codelineno-0-94" name="__codelineno-0-94"></a><span class="sd"> configured.</span>
|
|
<a id="__codelineno-0-95" name="__codelineno-0-95"></a><span class="sd"> should_log_exception_stack: Log the traces of unhandled exceptions.</span>
|
|
<a id="__codelineno-0-96" name="__codelineno-0-96"></a><span class="sd"> prediction_cache_size: Size of the LRU cache applied over the prediction</span>
|
|
<a id="__codelineno-0-97" name="__codelineno-0-97"></a><span class="sd"> functions.</span>
|
|
<a id="__codelineno-0-98" name="__codelineno-0-98"></a><span class="sd"> disable_se4ml_banner: Turn off the warning about the importance of SE4ML best-</span>
|
|
<a id="__codelineno-0-99" name="__codelineno-0-99"></a><span class="sd"> practices.</span>
|
|
<a id="__codelineno-0-100" name="__codelineno-0-100"></a><span class="sd"> dashboard_table_size: Number of rows to display in the dashboard's table.</span>
|
|
<a id="__codelineno-0-101" name="__codelineno-0-101"></a><span class="sd"> route_config: Enable or disable specific HTTP API endpoints.</span>
|
|
<a id="__codelineno-0-102" name="__codelineno-0-102"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-103" name="__codelineno-0-103"></a>
|
|
<a id="__codelineno-0-104" name="__codelineno-0-104"></a> <span class="k">global</span> <span class="n">_context</span>
|
|
<a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="n">logger</span> <span class="o">=</span> <span class="n">get_logger</span><span class="p">(</span><span class="s2">"great_ai"</span><span class="p">,</span> <span class="n">level</span><span class="o">=</span><span class="n">log_level</span><span class="p">)</span>
|
|
<a id="__codelineno-0-106" name="__codelineno-0-106"></a>
|
|
<a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="k">if</span> <span class="n">_context</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-108" name="__codelineno-0-108"></a> <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span>
|
|
<a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="s2">"Configuration has been already initialised, overwriting.</span><span class="se">\n</span><span class="s2">"</span>
|
|
<a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="o">+</span> <span class="s2">"Make sure to call `configure()` before importing your application code."</span>
|
|
<a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-112" name="__codelineno-0-112"></a>
|
|
<a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="n">is_production</span> <span class="o">=</span> <span class="n">_is_in_production_mode</span><span class="p">(</span><span class="n">logger</span><span class="o">=</span><span class="n">logger</span><span class="p">)</span>
|
|
<a id="__codelineno-0-114" name="__codelineno-0-114"></a>
|
|
<a id="__codelineno-0-115" name="__codelineno-0-115"></a> <span class="n">_set_seed</span><span class="p">(</span><span class="n">seed</span><span class="p">)</span>
|
|
<a id="__codelineno-0-116" name="__codelineno-0-116"></a>
|
|
<a id="__codelineno-0-117" name="__codelineno-0-117"></a> <span class="n">tracing_database_factory</span> <span class="o">=</span> <span class="n">_initialize_tracing_database</span><span class="p">(</span>
|
|
<a id="__codelineno-0-118" name="__codelineno-0-118"></a> <span class="n">tracing_database_factory</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span>
|
|
<a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="n">tracing_database</span> <span class="o">=</span> <span class="n">tracing_database_factory</span><span class="p">()</span>
|
|
<a id="__codelineno-0-121" name="__codelineno-0-121"></a>
|
|
<a id="__codelineno-0-122" name="__codelineno-0-122"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">tracing_database</span><span class="o">.</span><span class="n">is_production_ready</span><span class="p">:</span>
|
|
<a id="__codelineno-0-123" name="__codelineno-0-123"></a> <span class="n">message</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"""The selected tracing database (</span><span class="si">{</span>
|
|
<a id="__codelineno-0-124" name="__codelineno-0-124"></a> <span class="n">tracing_database_factory</span><span class="o">.</span><span class="vm">__name__</span>
|
|
<a id="__codelineno-0-125" name="__codelineno-0-125"></a> <span class="si">}</span><span class="s2">) is not recommended for production"""</span>
|
|
<a id="__codelineno-0-126" name="__codelineno-0-126"></a>
|
|
<a id="__codelineno-0-127" name="__codelineno-0-127"></a> <span class="k">if</span> <span class="n">is_production</span><span class="p">:</span>
|
|
<a id="__codelineno-0-128" name="__codelineno-0-128"></a> <span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
|
<a id="__codelineno-0-129" name="__codelineno-0-129"></a> <span class="k">else</span><span class="p">:</span>
|
|
<a id="__codelineno-0-130" name="__codelineno-0-130"></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="n">message</span><span class="p">)</span>
|
|
<a id="__codelineno-0-131" name="__codelineno-0-131"></a>
|
|
<a id="__codelineno-0-132" name="__codelineno-0-132"></a> <span class="n">_context</span> <span class="o">=</span> <span class="n">Context</span><span class="p">(</span>
|
|
<a id="__codelineno-0-133" name="__codelineno-0-133"></a> <span class="n">version</span><span class="o">=</span><span class="n">version</span><span class="p">,</span>
|
|
<a id="__codelineno-0-134" name="__codelineno-0-134"></a> <span class="n">tracing_database</span><span class="o">=</span><span class="n">tracing_database</span><span class="p">,</span>
|
|
<a id="__codelineno-0-135" name="__codelineno-0-135"></a> <span class="n">large_file_implementation</span><span class="o">=</span><span class="n">_initialize_large_file</span><span class="p">(</span>
|
|
<a id="__codelineno-0-136" name="__codelineno-0-136"></a> <span class="n">large_file_implementation</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span>
|
|
<a id="__codelineno-0-137" name="__codelineno-0-137"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-138" name="__codelineno-0-138"></a> <span class="n">is_production</span><span class="o">=</span><span class="n">is_production</span><span class="p">,</span>
|
|
<a id="__codelineno-0-139" name="__codelineno-0-139"></a> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span><span class="p">,</span>
|
|
<a id="__codelineno-0-140" name="__codelineno-0-140"></a> <span class="n">should_log_exception_stack</span><span class="o">=</span><span class="ow">not</span> <span class="n">is_production</span>
|
|
<a id="__codelineno-0-141" name="__codelineno-0-141"></a> <span class="k">if</span> <span class="n">should_log_exception_stack</span> <span class="ow">is</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-142" name="__codelineno-0-142"></a> <span class="k">else</span> <span class="n">should_log_exception_stack</span><span class="p">,</span>
|
|
<a id="__codelineno-0-143" name="__codelineno-0-143"></a> <span class="n">prediction_cache_size</span><span class="o">=</span><span class="n">prediction_cache_size</span><span class="p">,</span>
|
|
<a id="__codelineno-0-144" name="__codelineno-0-144"></a> <span class="n">dashboard_table_size</span><span class="o">=</span><span class="n">dashboard_table_size</span><span class="p">,</span>
|
|
<a id="__codelineno-0-145" name="__codelineno-0-145"></a> <span class="n">route_config</span><span class="o">=</span><span class="n">route_config</span><span class="p">,</span>
|
|
<a id="__codelineno-0-146" name="__codelineno-0-146"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-147" name="__codelineno-0-147"></a>
|
|
<a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"GreatAI (v</span><span class="si">{</span><span class="n">__version__</span><span class="si">}</span><span class="s2">): configured ✅"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">to_flat_dict</span><span class="p">()</span><span class="o">.</span><span class="n">items</span><span class="p">():</span>
|
|
<a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">LIST_ITEM_PREFIX</span><span class="si">}{</span><span class="n">k</span><span class="si">}</span><span class="s2">: </span><span class="si">{</span><span class="n">v</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-151" name="__codelineno-0-151"></a>
|
|
<a id="__codelineno-0-152" name="__codelineno-0-152"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">is_production</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">disable_se4ml_banner</span><span class="p">:</span>
|
|
<a id="__codelineno-0-153" name="__codelineno-0-153"></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span>
|
|
<a id="__codelineno-0-154" name="__codelineno-0-154"></a> <span class="s2">"You still need to check whether you follow all best practices before "</span>
|
|
<a id="__codelineno-0-155" name="__codelineno-0-155"></a> <span class="s2">"trusting your deployment."</span>
|
|
<a id="__codelineno-0-156" name="__codelineno-0-156"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-157" name="__codelineno-0-157"></a> <span class="n">logger</span><span class="o">.</span><span class="n">warning</span><span class="p">(</span><span class="sa">f</span><span class="s2">"> Find out more at </span><span class="si">{</span><span class="n">SE4ML_WEBSITE</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.save_model" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">save_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">key</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">keep_last_n</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.save_model" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Save (and optionally serialise) a model in order to use by <code>use_model</code>.</p>
|
|
<p>The <code>model</code> can be a Path or string representing a path in which case the
|
|
local file/folder is read and saved using the current LargeFile implementation.
|
|
In case <code>model</code> is an object, it is serialised using <code>dill</code> before uploading it.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">great_ai</span> <span class="kn">import</span> <span class="n">use_model</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">>>> </span><span class="n">save_model</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="s1">'my_number'</span><span class="p">)</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="go">'my_number:...'</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="nd">@use_model</span><span class="p">(</span><span class="s1">'my_number'</span><span class="p">)</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">model</span><span class="p">):</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="n">model</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="go">7</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>model</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[<span title="pathlib.Path">Path</span>, str, object]</code>
|
|
</td>
|
|
<td><p>The object or path to be uploaded.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>The model's name.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>keep_last_n</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[int]</code>
|
|
</td>
|
|
<td><p>If specified, remove old models and only keep the latest n. Directly passed to LargeFile.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>The key and version of the saved model separated by a colon. Example: "key:version"</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/models/save_model.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48">48</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-9" name="__codelineno-0-9"></a><span class="k">def</span> <span class="nf">save_model</span><span class="p">(</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10"></a> <span class="n">model</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="nb">object</span><span class="p">],</span> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">keep_last_n</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11"></a><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12"></a> <span class="sd">"""Save (and optionally serialise) a model in order to use by `use_model`.</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13"></a>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="sd"> The `model` can be a Path or string representing a path in which case the</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="sd"> local file/folder is read and saved using the current LargeFile implementation.</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="sd"> In case `model` is an object, it is serialised using `dill` before uploading it.</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a><span class="sd"> >>> from great_ai import use_model</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a><span class="sd"> >>> save_model(3, 'my_number')</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a><span class="sd"> 'my_number:...'</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a><span class="sd"> >>> @use_model('my_number')</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a><span class="sd"> ... def my_function(a, model):</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> ... return a + model</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a><span class="sd"> >>> my_function(4)</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> 7</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="sd"> model: The object or path to be uploaded.</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> key: The model's name.</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> keep_last_n: If specified, remove old models and only keep the latest n. Directly passed to LargeFile.</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a><span class="sd"> The key and version of the saved model separated by a colon. Example: "key:version"</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="n">file</span> <span class="o">=</span> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">large_file_implementation</span><span class="p">(</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="n">name</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">mode</span><span class="o">=</span><span class="s2">"wb"</span><span class="p">,</span> <span class="n">keep_last_n</span><span class="o">=</span><span class="n">keep_last_n</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Path</span><span class="p">)</span> <span class="ow">or</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="n">file</span><span class="o">.</span><span class="n">push</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a> <span class="k">else</span><span class="p">:</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a> <span class="k">with</span> <span class="n">file</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a> <span class="n">dump</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">f</span><span class="p">)</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Model </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2"> uploaded with version </span><span class="si">{</span><span class="n">file</span><span class="o">.</span><span class="n">version</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="k">return</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">file</span><span class="o">.</span><span class="n">version</span><span class="si">}</span><span class="s2">"</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.use_model" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">use_model</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="s1">'latest'</span><span class="p">,</span> <span class="n">model_kwarg_name</span><span class="o">=</span><span class="s1">'model'</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.use_model" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Inject a model into a function.</p>
|
|
<p>Load a model specified by <code>key</code> and <code>version</code> using the currently active <code>LargeFile</code>
|
|
implementation. If it's a single object, it is deserialised using <code>dill</code>. If it's a
|
|
directory of files, a <code>pathlib.Path</code> instance is given.</p>
|
|
<p>By default, the function's <code>model</code> parameter is replaced by the loaded model. This
|
|
can be customised by changing <code>model_kwarg_name</code>. Multiple models can be loaded by
|
|
decorating the same function with <code>use_model</code> multiple times.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="kn">from</span> <span class="nn">great_ai</span> <span class="kn">import</span> <span class="n">save_model</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">>>> </span><span class="n">save_model</span><span class="p">(</span><span class="mi">3</span><span class="p">,</span> <span class="s1">'my_number'</span><span class="p">)</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="go">'my_number:...'</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">>>> </span><span class="nd">@use_model</span><span class="p">(</span><span class="s1">'my_number'</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">a</span><span class="p">,</span> <span class="n">model</span><span class="p">):</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="gp">... </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="n">model</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="go">7</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>key</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>The model's name as stored by the LargeFile implementation.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>version</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[int, <span title="typing.Literal">Literal</span>['latest']]</code>
|
|
</td>
|
|
<td><p>The model's version as stored by the LargeFile implementation.</p></td>
|
|
<td>
|
|
<code>'latest'</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>model_kwarg_name</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>the parameter to use for injecting the loaded model</p></td>
|
|
<td>
|
|
<code>'model'</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code><span title="typing.Callable">Callable</span>[[<span title="great_ai.models.use_model.F">F</span>], <span title="great_ai.models.use_model.F">F</span>]</code>
|
|
</td>
|
|
<td><p>A decorator for model injection.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/models/use_model.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67">67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68">68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69">69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70">70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71">71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72">72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74">74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75">75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76">76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77">77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78">78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79">79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80">80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81">81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82">82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83">83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84">84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85">85</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="k">def</span> <span class="nf">use_model</span><span class="p">(</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a> <span class="n">key</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a> <span class="n">version</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">int</span><span class="p">,</span> <span class="n">Literal</span><span class="p">[</span><span class="s2">"latest"</span><span class="p">]]</span> <span class="o">=</span> <span class="s2">"latest"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a> <span class="n">model_kwarg_name</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"model"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="n">F</span><span class="p">],</span> <span class="n">F</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="sd">"""Inject a model into a function.</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd"> Load a model specified by `key` and `version` using the currently active `LargeFile`</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a><span class="sd"> implementation. If it's a single object, it is deserialised using `dill`. If it's a</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a><span class="sd"> directory of files, a `pathlib.Path` instance is given.</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a><span class="sd"> By default, the function's `model` parameter is replaced by the loaded model. This</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a><span class="sd"> can be customised by changing `model_kwarg_name`. Multiple models can be loaded by</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a><span class="sd"> decorating the same function with `use_model` multiple times.</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="sd"> >>> from great_ai import save_model</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a><span class="sd"> >>> save_model(3, 'my_number')</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a><span class="sd"> 'my_number:...'</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a><span class="sd"> >>> @use_model('my_number')</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a><span class="sd"> ... def my_function(a, model):</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="sd"> ... return a + model</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="sd"> >>> my_function(4)</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="sd"> 7</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="sd"> key: The model's name as stored by the LargeFile implementation.</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="sd"> version: The model's version as stored by the LargeFile implementation.</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a><span class="sd"> model_kwarg_name: the parameter to use for injecting the loaded model</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="sd"> A decorator for model injection.</span>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a> <span class="k">assert</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="nb">isinstance</span><span class="p">(</span><span class="n">version</span><span class="p">,</span> <span class="nb">int</span><span class="p">)</span> <span class="ow">or</span> <span class="n">version</span> <span class="o">==</span> <span class="s2">"latest"</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="p">),</span> <span class="s2">"Only integers or the string literal `latest` is allowed as a version"</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="n">model</span><span class="p">,</span> <span class="n">actual_version</span> <span class="o">=</span> <span class="n">_load_model</span><span class="p">(</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="n">version</span><span class="o">=</span><span class="kc">None</span> <span class="k">if</span> <span class="n">version</span> <span class="o">==</span> <span class="s2">"latest"</span> <span class="k">else</span> <span class="n">version</span><span class="p">,</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">F</span><span class="p">)</span> <span class="o">-></span> <span class="n">F</span><span class="p">:</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="n">assert_function_is_not_finalised</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="n">store</span> <span class="o">=</span> <span class="n">get_function_metadata_store</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="n">store</span><span class="o">.</span><span class="n">model_parameter_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">model_kwarg_name</span><span class="p">)</span>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="nd">@wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a> <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Any</span><span class="p">],</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="n">tracing_context</span> <span class="o">=</span> <span class="n">TracingContext</span><span class="o">.</span><span class="n">get_current_tracing_context</span><span class="p">()</span>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="k">if</span> <span class="n">tracing_context</span><span class="p">:</span>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="n">tracing_context</span><span class="o">.</span><span class="n">log_model</span><span class="p">(</span><span class="n">Model</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">version</span><span class="o">=</span><span class="n">actual_version</span><span class="p">))</span>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">,</span> <span class="o">**</span><span class="p">{</span><span class="n">model_kwarg_name</span><span class="p">:</span> <span class="n">model</span><span class="p">})</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="n">F</span><span class="p">,</span> <span class="n">wrapper</span><span class="p">)</span>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="k">return</span> <span class="n">decorator</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.parameter" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">parameter</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">validate</span><span class="o">=</span><span class="k">lambda</span> <span class="n">_</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> <span class="n">disable_logging</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.parameter" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Control the validation and logging of function parameters.</p>
|
|
<p>Basically, a parameter decorator. Unfortunately, Python does not have that concept,
|
|
thus, it's a method decorator that expects the name of the to-be-decorated
|
|
parameter.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="nd">@parameter</span><span class="p">(</span><span class="s1">'a'</span><span class="p">)</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">a</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="mi">2</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="mi">4</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="go">6</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="s1">'3'</span><span class="p">)</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="gt">Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="gr">TypeError</span>: <span class="n">type of a must be int; got str instead</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="nd">@parameter</span><span class="p">(</span><span class="s1">'positive_a'</span><span class="p">,</span> <span class="n">validate</span><span class="o">=</span><span class="k">lambda</span> <span class="n">v</span><span class="p">:</span> <span class="n">v</span> <span class="o">></span> <span class="mi">0</span><span class="p">)</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span><span class="k">def</span> <span class="nf">my_function</span><span class="p">(</span><span class="n">positive_a</span><span class="p">:</span> <span class="nb">int</span><span class="p">):</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="k">return</span> <span class="n">a</span> <span class="o">+</span> <span class="mi">2</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">>>> </span><span class="n">my_function</span><span class="p">(</span><span class="o">-</span><span class="mi">1</span><span class="p">)</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="gt">Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="gr">great_ai.errors.argument_validation_error.ArgumentValidationError</span>: <span class="n">...</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>parameter_name</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>Name of parameter to consider.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>validate</code></td>
|
|
<td>
|
|
<code><span title="typing.Callable">Callable</span>[[<span title="typing.Any">Any</span>], bool]</code>
|
|
</td>
|
|
<td><p>Optional validate to run against the concrete argument.
|
|
ArgumentValidationError is thrown when the return value is False.</p></td>
|
|
<td>
|
|
<code>lambda _: True</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>disable_logging</code></td>
|
|
<td>
|
|
<code>bool</code>
|
|
</td>
|
|
<td><p>Do not save the value in any active TracingContext.</p></td>
|
|
<td>
|
|
<code>False</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<p><strong>Returns:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>
|
|
<code><span title="typing.Callable">Callable</span>[[<span title="great_ai.parameters.parameter.F">F</span>], <span title="great_ai.parameters.parameter.F">F</span>]</code>
|
|
</td>
|
|
<td><p>A decorator for argument validation.</p></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/parameters/parameter.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67">67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68">68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69">69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70">70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71">71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72">72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74">74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75">75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76">76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77">77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78">78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79">79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80">80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81">81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82">82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83">83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84">84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85">85</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-86">86</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-87">87</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="k">def</span> <span class="nf">parameter</span><span class="p">(</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a> <span class="n">parameter_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a> <span class="n">validate</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">Any</span><span class="p">],</span> <span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="k">lambda</span> <span class="n">_</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a> <span class="n">disable_logging</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Callable</span><span class="p">[[</span><span class="n">F</span><span class="p">],</span> <span class="n">F</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="sd">"""Control the validation and logging of function parameters.</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="sd"> Basically, a parameter decorator. Unfortunately, Python does not have that concept,</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a><span class="sd"> thus, it's a method decorator that expects the name of the to-be-decorated</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a><span class="sd"> parameter.</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> >>> @parameter('a')</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a><span class="sd"> ... def my_function(a: int):</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a><span class="sd"> ... return a + 2</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="sd"> >>> my_function(4)</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> 6</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> >>> my_function('3')</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd"> Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a><span class="sd"> ...</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd"> TypeError: type of a must be int; got str instead</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a><span class="sd"> >>> @parameter('positive_a', validate=lambda v: v > 0)</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a><span class="sd"> ... def my_function(positive_a: int):</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a><span class="sd"> ... return a + 2</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a><span class="sd"> >>> my_function(-1)</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a><span class="sd"> Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a><span class="sd"> ...</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a><span class="sd"> great_ai.errors.argument_validation_error.ArgumentValidationError: ...</span>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a><span class="sd"> parameter_name: Name of parameter to consider.</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a><span class="sd"> validate: Optional validate to run against the concrete argument.</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a><span class="sd"> ArgumentValidationError is thrown when the return value is False.</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="sd"> disable_logging: Do not save the value in any active TracingContext.</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="sd"> Returns:</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="sd"> A decorator for argument validation.</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="k">def</span> <span class="nf">decorator</span><span class="p">(</span><span class="n">func</span><span class="p">:</span> <span class="n">F</span><span class="p">)</span> <span class="o">-></span> <span class="n">F</span><span class="p">:</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="n">get_function_metadata_store</span><span class="p">(</span><span class="n">func</span><span class="p">)</span><span class="o">.</span><span class="n">input_parameter_names</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">)</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a> <span class="n">assert_function_is_not_finalised</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a> <span class="n">actual_name</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"arg:</span><span class="si">{</span><span class="n">parameter_name</span><span class="si">}</span><span class="s2">"</span>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a> <span class="nd">@wraps</span><span class="p">(</span><span class="n">func</span><span class="p">)</span>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a> <span class="k">def</span> <span class="nf">wrapper</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="n">arguments</span> <span class="o">=</span> <span class="n">get_arguments</span><span class="p">(</span><span class="n">func</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="n">argument</span> <span class="o">=</span> <span class="n">arguments</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">)</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="n">expected_type</span> <span class="o">=</span> <span class="n">func</span><span class="o">.</span><span class="vm">__annotations__</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">)</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="k">if</span> <span class="n">expected_type</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="n">check_type</span><span class="p">(</span><span class="n">parameter_name</span><span class="p">,</span> <span class="n">argument</span><span class="p">,</span> <span class="n">expected_type</span><span class="p">)</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">validate</span><span class="p">(</span><span class="n">argument</span><span class="p">):</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="k">raise</span> <span class="n">ArgumentValidationError</span><span class="p">(</span>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="sa">f</span><span class="s2">"""Argument </span><span class="si">{</span><span class="n">parameter_name</span><span class="si">}</span><span class="s2"> in </span><span class="si">{</span>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="n">func</span><span class="o">.</span><span class="vm">__name__</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="si">}</span><span class="s2"> did not pass validation"""</span>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a> <span class="n">context</span> <span class="o">=</span> <span class="n">TracingContext</span><span class="o">.</span><span class="n">get_current_tracing_context</span><span class="p">()</span>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="k">if</span> <span class="n">context</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">disable_logging</span><span class="p">:</span>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="n">context</span><span class="o">.</span><span class="n">log_value</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">actual_name</span><span class="si">}</span><span class="s2">:value"</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">argument</span><span class="p">)</span>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">argument</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="n">context</span><span class="o">.</span><span class="n">log_value</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">actual_name</span><span class="si">}</span><span class="s2">:length"</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="nb">len</span><span class="p">(</span><span class="n">argument</span><span class="p">))</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="k">return</span> <span class="n">cast</span><span class="p">(</span><span class="n">F</span><span class="p">,</span> <span class="n">wrapper</span><span class="p">)</span>
|
|
<a id="__codelineno-0-86" name="__codelineno-0-86"></a>
|
|
<a id="__codelineno-0-87" name="__codelineno-0-87"></a> <span class="k">return</span> <span class="n">decorator</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.log_metric" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">log_metric</span><span class="p">(</span><span class="n">argument_name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.log_metric" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Log a key (argument_name)-value pair that is persisted inside the trace.</p>
|
|
<p>The name of the function from where this is called is also stored.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>argument_name</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>The key for storing the value.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>value</code></td>
|
|
<td>
|
|
<code><span title="typing.Any">Any</span></code>
|
|
</td>
|
|
<td><p>Value to log. Must be JSON-serialisable.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/parameters/log_metric.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-8" name="__codelineno-0-8"></a><span class="k">def</span> <span class="nf">log_metric</span><span class="p">(</span><span class="n">argument_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9"></a> <span class="sd">"""Log a key (argument_name)-value pair that is persisted inside the trace.</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10"></a>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11"></a><span class="sd"> The name of the function from where this is called is also stored.</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12"></a>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="sd"> argument_name: The key for storing the value.</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="sd"> value: Value to log. Must be JSON-serialisable.</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a> <span class="n">tracing_context</span> <span class="o">=</span> <span class="n">TracingContext</span><span class="o">.</span><span class="n">get_current_tracing_context</span><span class="p">()</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a> <span class="n">caller</span> <span class="o">=</span> <span class="n">inspect</span><span class="o">.</span><span class="n">stack</span><span class="p">()[</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">function</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="n">actual_name</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"metric:</span><span class="si">{</span><span class="n">caller</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">argument_name</span><span class="si">}</span><span class="s2">"</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a> <span class="k">if</span> <span class="n">tracing_context</span><span class="p">:</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a> <span class="n">tracing_context</span><span class="o">.</span><span class="n">log_value</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="n">actual_name</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">value</span><span class="p">)</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">info</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">actual_name</span><span class="si">}</span><span class="s2">=</span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div><h2 id="remote-calls">Remote calls<a class="headerlink" href="#remote-calls" title="Permanent link">#</a></h2>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.call_remote_great_ai" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">call_remote_great_ai</span><span class="p">(</span><span class="n">base_uri</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">retry_count</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">timeout_in_seconds</span><span class="o">=</span><span class="mi">300</span><span class="p">,</span> <span class="n">model_class</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.call_remote_great_ai" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Communicate with a GreatAI object through an HTTP request.</p>
|
|
<p>Wrapper over <code>call_remote_great_ai_async</code> making it synchronous. For more info, see
|
|
<code>call_remote_great_ai_async</code>.</p>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/remote/call_remote_great_ai.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="k">def</span> <span class="nf">call_remote_great_ai</span><span class="p">(</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a> <span class="n">base_uri</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a> <span class="n">data</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a> <span class="n">retry_count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">4</span><span class="p">,</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="n">timeout_in_seconds</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="mi">300</span><span class="p">,</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a> <span class="n">model_class</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">T</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Trace</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="sd">"""Communicate with a GreatAI object through an HTTP request.</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> Wrapper over `call_remote_great_ai_async` making it synchronous. For more info, see</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a><span class="sd"> `call_remote_great_ai_async`.</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a> <span class="n">asyncio</span><span class="o">.</span><span class="n">get_running_loop</span><span class="p">()</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a> <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a> <span class="sa">f</span><span class="s2">"Already running in an event loop, you have to call `</span><span class="si">{</span><span class="n">call_remote_great_ai_async</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2">`"</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="k">except</span> <span class="ne">RuntimeError</span><span class="p">:</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="n">future</span> <span class="o">=</span> <span class="n">call_remote_great_ai_async</span><span class="p">(</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="n">base_uri</span><span class="o">=</span><span class="n">base_uri</span><span class="p">,</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">,</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a> <span class="n">retry_count</span><span class="o">=</span><span class="n">retry_count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="n">timeout_in_seconds</span><span class="o">=</span><span class="n">timeout_in_seconds</span><span class="p">,</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="n">model_class</span><span class="o">=</span><span class="n">model_class</span><span class="p">,</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a> <span class="k">return</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">future</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.call_remote_great_ai_async" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">call_remote_great_ai_async</span><span class="p">(</span><span class="n">base_uri</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">retry_count</span><span class="o">=</span><span class="mi">4</span><span class="p">,</span> <span class="n">timeout_in_seconds</span><span class="o">=</span><span class="mi">300</span><span class="p">,</span> <span class="n">model_class</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-async"><code>async</code></small>
|
|
</span>
|
|
|
|
<a href="#great_ai.call_remote_great_ai_async" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Communicate with a GreatAI object through an HTTP request.</p>
|
|
<p>Send a POST request using <a href="https://www.python-httpx.org/">httpx</a> to implement a
|
|
remote call. Error-handling and retries are provided by httpx.</p>
|
|
<p>The return value is inflated into a Trace. If <code>model_class</code> is specified, the
|
|
original output is deserialised.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>base_uri</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>Address of the remote instance, example: 'http://localhost:6060'</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>data</code></td>
|
|
<td>
|
|
<code><span title="typing.Mapping">Mapping</span>[str, <span title="typing.Any">Any</span>]</code>
|
|
</td>
|
|
<td><p>The input sent as a json to the remote instance.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>retry_count</code></td>
|
|
<td>
|
|
<code>int</code>
|
|
</td>
|
|
<td><p>Retry on any HTTP communication failure.</p></td>
|
|
<td>
|
|
<code>4</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>timeout_in_seconds</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[int]</code>
|
|
</td>
|
|
<td><p>Overall permissible max length of the request. <code>None</code> means
|
|
no timeout.</p></td>
|
|
<td>
|
|
<code>300</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>model_class</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="typing.Type">Type</span>[<span title="great_ai.remote.call_remote_great_ai_async.T">T</span>]]</code>
|
|
</td>
|
|
<td><p>A subtype of BaseModel to be used for deserialising the <code>.output</code>
|
|
of the trace.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/remote/call_remote_great_ai_async.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67">67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68">68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69">69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70">70</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-12" name="__codelineno-0-12"></a><span class="k">async</span> <span class="k">def</span> <span class="nf">call_remote_great_ai_async</span><span class="p">(</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">base_uri</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14"></a> <span class="n">data</span><span class="p">:</span> <span class="n">Mapping</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">],</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a> <span class="n">retry_count</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">4</span><span class="p">,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a> <span class="n">timeout_in_seconds</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="mi">300</span><span class="p">,</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a> <span class="n">model_class</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">T</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="p">)</span> <span class="o">-></span> <span class="n">Trace</span><span class="p">[</span><span class="n">T</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a> <span class="sd">"""Communicate with a GreatAI object through an HTTP request.</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a><span class="sd"> Send a POST request using [httpx](https://www.python-httpx.org/) to implement a</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="sd"> remote call. Error-handling and retries are provided by httpx.</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a><span class="sd"> The return value is inflated into a Trace. If `model_class` is specified, the</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> original output is deserialised.</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a><span class="sd"> base_uri: Address of the remote instance, example: 'http://localhost:6060'</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a><span class="sd"> data: The input sent as a json to the remote instance.</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="sd"> retry_count: Retry on any HTTP communication failure.</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> timeout_in_seconds: Overall permissible max length of the request. `None` means</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> no timeout.</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd"> model_class: A subtype of BaseModel to be used for deserialising the `.output`</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a><span class="sd"> of the trace.</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="k">if</span> <span class="n">base_uri</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"/"</span><span class="p">):</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="n">base_uri</span> <span class="o">=</span> <span class="n">base_uri</span><span class="p">[:</span><span class="o">-</span><span class="mi">1</span><span class="p">]</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">base_uri</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"/predict"</span><span class="p">):</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="n">base_uri</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">base_uri</span><span class="si">}</span><span class="s2">/predict"</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a> <span class="n">transport</span> <span class="o">=</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncHTTPTransport</span><span class="p">(</span><span class="n">retries</span><span class="o">=</span><span class="n">retry_count</span><span class="p">)</span>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="k">async</span> <span class="k">with</span> <span class="n">httpx</span><span class="o">.</span><span class="n">AsyncClient</span><span class="p">(</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a> <span class="n">transport</span><span class="o">=</span><span class="n">transport</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="n">timeout_in_seconds</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="n">response</span> <span class="o">=</span> <span class="k">await</span> <span class="n">client</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="n">base_uri</span><span class="p">,</span> <span class="n">json</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a> <span class="n">response</span><span class="o">.</span><span class="n">raise_for_status</span><span class="p">()</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a> <span class="k">raise</span> <span class="n">RemoteCallError</span><span class="p">(</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="sa">f</span><span class="s2">"Unexpected status code, reason: </span><span class="si">{</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="si">}</span><span class="s2">"</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a> <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a> <span class="k">raise</span> <span class="n">RemoteCallError</span> <span class="kn">from</span> <span class="nn">e</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a> <span class="n">trace</span> <span class="o">=</span> <span class="n">response</span><span class="o">.</span><span class="n">json</span><span class="p">()</span>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="k">raise</span> <span class="n">RemoteCallError</span><span class="p">(</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="sa">f</span><span class="s2">"JSON parsing failed </span><span class="si">{</span><span class="n">response</span><span class="o">.</span><span class="n">text</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="k">try</span><span class="p">:</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="k">if</span> <span class="n">model_class</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="n">trace</span><span class="p">[</span><span class="s2">"output"</span><span class="p">]</span> <span class="o">=</span> <span class="n">model_class</span><span class="o">.</span><span class="n">parse_obj</span><span class="p">(</span><span class="n">trace</span><span class="p">[</span><span class="s2">"output"</span><span class="p">])</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="k">return</span> <span class="n">Trace</span><span class="o">.</span><span class="n">parse_obj</span><span class="p">(</span><span class="n">trace</span><span class="p">)</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="k">raise</span> <span class="n">RemoteCallError</span><span class="p">(</span><span class="s2">"Could not parse Trace"</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div><h2 id="ground-truth">Ground-truth<a class="headerlink" href="#ground-truth" title="Permanent link">#</a></h2>
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.add_ground_truth" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">add_ground_truth</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">expected_outputs</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">tags</span><span class="o">=</span><span class="p">[],</span> <span class="n">train_split_ratio</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">test_split_ratio</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">validation_split_ratio</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.add_ground_truth" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Add training data (with optional train-test splitting).</p>
|
|
<p>Add and tag data-points, wrap them into traces. The <code>inputs</code> are available via the
|
|
<code>.input</code> property, while <code>expected_outputs</code> under both the <code>.output</code> and <code>.feedback</code>
|
|
properties.</p>
|
|
<p>All generated traces are tagged with <code>ground_truth</code> by default. Additional tags can
|
|
be also provided. Using the <code>split_ratio</code> arguments, tags can be given randomly with
|
|
a user-defined distribution. Only the ratio of the splits matter, they don't have to
|
|
add up to 1.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="n">add_ground_truth</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">3</span><span class="p">],</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="p">[</span><span class="s1">'odd'</span><span class="p">,</span> <span class="s1">'even'</span><span class="p">,</span> <span class="s1">'odd'</span><span class="p">],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">... </span> <span class="n">tags</span><span class="o">=</span><span class="s1">'my_tag'</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="gp">... </span> <span class="n">train_split_ratio</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="gp">... </span> <span class="n">test_split_ratio</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="gp">... </span> <span class="n">validation_split_ratio</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="gp">... </span><span class="p">)</span>
|
|
</code></pre></div>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="n">add_ground_truth</span><span class="p">(</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">... </span> <span class="p">[</span><span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">],</span>
|
|
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span> <span class="p">[</span><span class="s1">'odd'</span><span class="p">,</span> <span class="s1">'even'</span><span class="p">,</span> <span class="s1">'odd'</span><span class="p">],</span>
|
|
<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">... </span> <span class="n">tags</span><span class="o">=</span><span class="s1">'my_tag'</span><span class="p">,</span>
|
|
<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="gp">... </span> <span class="n">train_split_ratio</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="gp">... </span> <span class="n">test_split_ratio</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="gp">... </span> <span class="n">validation_split_ratio</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="gp">... </span><span class="p">)</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="gt">Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a> <span class="o">...</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="gr">AssertionError</span>: <span class="n">The length of the inputs and expected_outputs must be equal</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>inputs</code></td>
|
|
<td>
|
|
<code><span title="typing.Iterable">Iterable</span>[<span title="typing.Any">Any</span>]</code>
|
|
</td>
|
|
<td><p>The inputs. (X in scikit-learn)</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>expected_outputs</code></td>
|
|
<td>
|
|
<code><span title="typing.Iterable">Iterable</span>[<span title="great_ai.tracing.add_ground_truth.T">T</span>]</code>
|
|
</td>
|
|
<td><p>The ground-truth values corresponding to the inputs. (y in
|
|
scikit-learn)</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>tags</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[<span title="typing.List">List</span>[str], str]</code>
|
|
</td>
|
|
<td><p>A single tag or a list of tags to append to each generated trace's tags.</p></td>
|
|
<td>
|
|
<code>[]</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>train_split_ratio</code></td>
|
|
<td>
|
|
<code>float</code>
|
|
</td>
|
|
<td><p>The probability-weight of giving each trace the <code>train</code> tag.</p></td>
|
|
<td>
|
|
<code>1</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>test_split_ratio</code></td>
|
|
<td>
|
|
<code>float</code>
|
|
</td>
|
|
<td><p>The probability-weight of giving each trace the <code>test</code> tag.</p></td>
|
|
<td>
|
|
<code>0</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>validation_split_ratio</code></td>
|
|
<td>
|
|
<code>float</code>
|
|
</td>
|
|
<td><p>The probability-weight of giving each trace the
|
|
<code>validation</code> tag.</p></td>
|
|
<td>
|
|
<code>0</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/tracing/add_ground_truth.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-19"> 19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20"> 20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21"> 21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22"> 22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23"> 23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24"> 24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25"> 25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26"> 26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27"> 27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28"> 28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29"> 29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30"> 30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31"> 31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32"> 32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33"> 33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34"> 34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35"> 35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36"> 36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37"> 37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38"> 38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39"> 39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40"> 40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41"> 41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42"> 42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43"> 43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44"> 44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45"> 45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46"> 46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47"> 47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48"> 48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49"> 49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50"> 50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51"> 51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52"> 52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53"> 53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54"> 54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55"> 55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56"> 56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57"> 57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58"> 58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59"> 59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60"> 60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61"> 61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62"> 62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63"> 63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64"> 64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65"> 65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66"> 66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67"> 67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68"> 68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69"> 69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70"> 70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71"> 71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72"> 72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73"> 73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74"> 74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75"> 75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76"> 76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77"> 77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78"> 78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79"> 79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80"> 80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81"> 81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82"> 82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83"> 83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84"> 84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85"> 85</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-86"> 86</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-87"> 87</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-88"> 88</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-89"> 89</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-90"> 90</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-91"> 91</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-92"> 92</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-93"> 93</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-114">114</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-116">116</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-19" name="__codelineno-0-19"></a><span class="k">def</span> <span class="nf">add_ground_truth</span><span class="p">(</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="n">inputs</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">Any</span><span class="p">],</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a> <span class="n">expected_outputs</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="n">T</span><span class="p">],</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="n">tags</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a> <span class="n">train_split_ratio</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">1</span><span class="p">,</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a> <span class="n">test_split_ratio</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a> <span class="n">validation_split_ratio</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="mi">0</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a> <span class="sd">"""Add training data (with optional train-test splitting).</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="sd"> Add and tag data-points, wrap them into traces. The `inputs` are available via the</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> `.input` property, while `expected_outputs` under both the `.output` and `.feedback`</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> properties.</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a><span class="sd"> All generated traces are tagged with `ground_truth` by default. Additional tags can</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd"> be also provided. Using the `split_ratio` arguments, tags can be given randomly with</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a><span class="sd"> a user-defined distribution. Only the ratio of the splits matter, they don't have to</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a><span class="sd"> add up to 1.</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a><span class="sd"> >>> add_ground_truth(</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a><span class="sd"> ... [1, 2, 3],</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a><span class="sd"> ... ['odd', 'even', 'odd'],</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a><span class="sd"> ... tags='my_tag',</span>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a><span class="sd"> ... train_split_ratio=1,</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a><span class="sd"> ... test_split_ratio=1,</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a><span class="sd"> ... validation_split_ratio=0.5,</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a><span class="sd"> ... )</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="sd"> >>> add_ground_truth(</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="sd"> ... [1, 2],</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="sd"> ... ['odd', 'even', 'odd'],</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd"> ... tags='my_tag',</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a><span class="sd"> ... train_split_ratio=1,</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="sd"> ... test_split_ratio=1,</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="sd"> ... validation_split_ratio=0.5,</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a><span class="sd"> ... )</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a><span class="sd"> Traceback (most recent call last):</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="sd"> ...</span>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> AssertionError: The length of the inputs and expected_outputs must be equal</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="sd"> inputs: The inputs. (X in scikit-learn)</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="sd"> expected_outputs: The ground-truth values corresponding to the inputs. (y in</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="sd"> scikit-learn)</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a><span class="sd"> tags: A single tag or a list of tags to append to each generated trace's tags.</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a><span class="sd"> train_split_ratio: The probability-weight of giving each trace the `train` tag.</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a><span class="sd"> test_split_ratio: The probability-weight of giving each trace the `test` tag.</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a><span class="sd"> validation_split_ratio: The probability-weight of giving each trace the</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a><span class="sd"> `validation` tag.</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="n">inputs</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="n">expected_outputs</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="n">expected_outputs</span><span class="p">)</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="k">assert</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">)</span> <span class="o">==</span> <span class="nb">len</span><span class="p">(</span>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a> <span class="n">expected_outputs</span>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="p">),</span> <span class="s2">"The length of the inputs and expected_outputs must be equal"</span>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="n">tags</span> <span class="o">=</span> <span class="n">tags</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">tags</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> <span class="p">[</span><span class="n">tags</span><span class="p">]</span>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="n">sum_ratio</span> <span class="o">=</span> <span class="n">train_split_ratio</span> <span class="o">+</span> <span class="n">test_split_ratio</span> <span class="o">+</span> <span class="n">validation_split_ratio</span>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="k">assert</span> <span class="n">sum_ratio</span> <span class="o">></span> <span class="mi">0</span><span class="p">,</span> <span class="s2">"The sum of the split ratios must be a positive number"</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="n">train_split_ratio</span> <span class="o">/=</span> <span class="n">sum_ratio</span>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a> <span class="n">test_split_ratio</span> <span class="o">/=</span> <span class="n">sum_ratio</span>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="n">validation_split_ratio</span> <span class="o">/=</span> <span class="n">sum_ratio</span>
|
|
<a id="__codelineno-0-86" name="__codelineno-0-86"></a>
|
|
<a id="__codelineno-0-87" name="__codelineno-0-87"></a> <span class="n">values</span> <span class="o">=</span> <span class="nb">list</span><span class="p">(</span><span class="nb">zip</span><span class="p">(</span><span class="n">inputs</span><span class="p">,</span> <span class="n">expected_outputs</span><span class="p">))</span>
|
|
<a id="__codelineno-0-88" name="__codelineno-0-88"></a> <span class="n">shuffle</span><span class="p">(</span><span class="n">values</span><span class="p">)</span>
|
|
<a id="__codelineno-0-89" name="__codelineno-0-89"></a>
|
|
<a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="n">split_tags</span> <span class="o">=</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-91" name="__codelineno-0-91"></a> <span class="p">[</span><span class="n">TRAIN_SPLIT_TAG_NAME</span><span class="p">]</span> <span class="o">*</span> <span class="n">ceil</span><span class="p">(</span><span class="n">train_split_ratio</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">))</span>
|
|
<a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="o">+</span> <span class="p">[</span><span class="n">TEST_SPLIT_TAG_NAME</span><span class="p">]</span> <span class="o">*</span> <span class="n">ceil</span><span class="p">(</span><span class="n">test_split_ratio</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">))</span>
|
|
<a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="o">+</span> <span class="p">[</span><span class="n">VALIDATION_SPLIT_TAG_NAME</span><span class="p">]</span> <span class="o">*</span> <span class="n">ceil</span><span class="p">(</span><span class="n">validation_split_ratio</span> <span class="o">*</span> <span class="nb">len</span><span class="p">(</span><span class="n">inputs</span><span class="p">))</span>
|
|
<a id="__codelineno-0-94" name="__codelineno-0-94"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="n">shuffle</span><span class="p">(</span><span class="n">split_tags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-96" name="__codelineno-0-96"></a>
|
|
<a id="__codelineno-0-97" name="__codelineno-0-97"></a> <span class="n">created</span> <span class="o">=</span> <span class="n">datetime</span><span class="o">.</span><span class="n">utcnow</span><span class="p">()</span><span class="o">.</span><span class="n">isoformat</span><span class="p">()</span>
|
|
<a id="__codelineno-0-98" name="__codelineno-0-98"></a> <span class="n">traces</span> <span class="o">=</span> <span class="p">[</span>
|
|
<a id="__codelineno-0-99" name="__codelineno-0-99"></a> <span class="n">cast</span><span class="p">(</span>
|
|
<a id="__codelineno-0-100" name="__codelineno-0-100"></a> <span class="n">Trace</span><span class="p">[</span><span class="n">T</span><span class="p">],</span>
|
|
<a id="__codelineno-0-101" name="__codelineno-0-101"></a> <span class="n">Trace</span><span class="p">(</span> <span class="c1"># avoid ValueError: "Trace" object has no field "__orig_class__"</span>
|
|
<a id="__codelineno-0-102" name="__codelineno-0-102"></a> <span class="n">trace_id</span><span class="o">=</span><span class="nb">str</span><span class="p">(</span><span class="n">uuid4</span><span class="p">()),</span>
|
|
<a id="__codelineno-0-103" name="__codelineno-0-103"></a> <span class="n">created</span><span class="o">=</span><span class="n">created</span><span class="p">,</span>
|
|
<a id="__codelineno-0-104" name="__codelineno-0-104"></a> <span class="n">original_execution_time_ms</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="n">logged_values</span><span class="o">=</span><span class="n">X</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">X</span><span class="p">,</span> <span class="nb">dict</span><span class="p">)</span> <span class="k">else</span> <span class="p">{</span><span class="s2">"input"</span><span class="p">:</span> <span class="n">X</span><span class="p">},</span>
|
|
<a id="__codelineno-0-106" name="__codelineno-0-106"></a> <span class="n">models</span><span class="o">=</span><span class="p">[],</span>
|
|
<a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="n">output</span><span class="o">=</span><span class="n">y</span><span class="p">,</span>
|
|
<a id="__codelineno-0-108" name="__codelineno-0-108"></a> <span class="n">feedback</span><span class="o">=</span><span class="n">y</span><span class="p">,</span>
|
|
<a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="n">exception</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="n">tags</span><span class="o">=</span><span class="p">[</span><span class="n">GROUND_TRUTH_TAG_NAME</span><span class="p">,</span> <span class="n">split_tag</span><span class="p">,</span> <span class="o">*</span><span class="n">tags</span><span class="p">],</span>
|
|
<a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="p">),</span>
|
|
<a id="__codelineno-0-112" name="__codelineno-0-112"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="k">for</span> <span class="p">((</span><span class="n">X</span><span class="p">,</span> <span class="n">y</span><span class="p">),</span> <span class="n">split_tag</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">values</span><span class="p">,</span> <span class="n">split_tags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="p">]</span>
|
|
<a id="__codelineno-0-115" name="__codelineno-0-115"></a>
|
|
<a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">tracing_database</span><span class="o">.</span><span class="n">save_batch</span><span class="p">(</span><span class="n">traces</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.query_ground_truth" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">query_ground_truth</span><span class="p">(</span><span class="n">conjunctive_tags</span><span class="o">=</span><span class="p">[],</span> <span class="o">*</span><span class="p">,</span> <span class="n">since</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">until</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">return_max_count</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.query_ground_truth" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Return training samples.</p>
|
|
<p>Combines, filters, and returns data-points that have been either added by
|
|
<code>add_ground_truth</code> or were the result of a prediction after which their trace got
|
|
feedback through the RESP API-s <code>/traces/{trace_id}/feedback</code> endpoint
|
|
(end-to-end feedback).</p>
|
|
<p>Filtering can be used to only return points matching all given tags (or the single
|
|
given tag) and by time of creation.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="n">query_ground_truth</span><span class="p">()</span>
|
|
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="go">[...]</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>conjunctive_tags</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[<span title="typing.List">List</span>[str], str]</code>
|
|
</td>
|
|
<td><p>Single tag or a list of tags which the returned traces have to
|
|
match. The relationship between the tags is conjunctive (AND).</p></td>
|
|
<td>
|
|
<code>[]</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>since</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="datetime.datetime">datetime</span>]</code>
|
|
</td>
|
|
<td><p>Only return traces created after the given timestamp. <code>None</code> means no
|
|
filtering.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>until</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="datetime.datetime">datetime</span>]</code>
|
|
</td>
|
|
<td><p>Only return traces created before the given timestamp. <code>None</code> means no
|
|
filtering.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>return_max_count</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[int]</code>
|
|
</td>
|
|
<td><p>Return at-most this many traces. (take, limit)</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/tracing/query_ground_truth.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51">51</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-8" name="__codelineno-0-8"></a><span class="k">def</span> <span class="nf">query_ground_truth</span><span class="p">(</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9"></a> <span class="n">conjunctive_tags</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11"></a> <span class="n">since</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12"></a> <span class="n">until</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">return_max_count</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a> <span class="sd">"""Return training samples.</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a><span class="sd"> Combines, filters, and returns data-points that have been either added by</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="sd"> `add_ground_truth` or were the result of a prediction after which their trace got</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a><span class="sd"> feedback through the RESP API-s `/traces/{trace_id}/feedback` endpoint</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a><span class="sd"> (end-to-end feedback).</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="sd"> Filtering can be used to only return points matching all given tags (or the single</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a><span class="sd"> given tag) and by time of creation.</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a><span class="sd"> >>> query_ground_truth()</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> [...]</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="sd"> conjunctive_tags: Single tag or a list of tags which the returned traces have to</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="sd"> match. The relationship between the tags is conjunctive (AND).</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="sd"> since: Only return traces created after the given timestamp. `None` means no</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd"> filtering.</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a><span class="sd"> until: Only return traces created before the given timestamp. `None` means no</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd"> filtering.</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a><span class="sd"> return_max_count: Return at-most this many traces. (take, limit)</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a> <span class="n">tags</span> <span class="o">=</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="n">conjunctive_tags</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">conjunctive_tags</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> <span class="p">[</span><span class="n">conjunctive_tags</span><span class="p">]</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a> <span class="n">db</span> <span class="o">=</span> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">tracing_database</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a> <span class="n">items</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">query</span><span class="p">(</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a> <span class="n">conjunctive_tags</span><span class="o">=</span><span class="n">tags</span><span class="p">,</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="n">since</span><span class="o">=</span><span class="n">since</span><span class="p">,</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a> <span class="n">until</span><span class="o">=</span><span class="n">until</span><span class="p">,</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="n">take</span><span class="o">=</span><span class="n">return_max_count</span><span class="p">,</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="n">has_feedback</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a> <span class="k">return</span> <span class="n">items</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h3 id="great_ai.delete_ground_truth" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">delete_ground_truth</span><span class="p">(</span><span class="n">conjunctive_tags</span><span class="o">=</span><span class="p">[],</span> <span class="o">*</span><span class="p">,</span> <span class="n">since</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">until</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
|
|
|
|
<a href="#great_ai.delete_ground_truth" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
|
|
<p>Delete traces matching the given criteria.</p>
|
|
<p>Takes the same arguments as <code>query_ground_truth</code> but instead of returning them,
|
|
it simply deletes them.</p>
|
|
<p>You can rely on the efficiency of the delete's implementation.</p>
|
|
|
|
<p><strong>Examples:</strong></p>
|
|
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">>>> </span><span class="n">delete_ground_truth</span><span class="p">([</span><span class="s1">'train'</span><span class="p">,</span> <span class="s1">'test'</span><span class="p">,</span> <span class="s1">'validation'</span><span class="p">])</span>
|
|
</code></pre></div>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>conjunctive_tags</code></td>
|
|
<td>
|
|
<code><span title="typing.Union">Union</span>[<span title="typing.List">List</span>[str], str]</code>
|
|
</td>
|
|
<td><p>Single tag or a list of tags which the deleted traces have to
|
|
match. The relationship between the tags is conjunctive (AND).</p></td>
|
|
<td>
|
|
<code>[]</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>since</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="datetime.datetime">datetime</span>]</code>
|
|
</td>
|
|
<td><p>Only delete traces created after the given timestamp. <code>None</code> means no
|
|
filtering.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>until</code></td>
|
|
<td>
|
|
<code><span title="typing.Optional">Optional</span>[<span title="datetime.datetime">datetime</span>]</code>
|
|
</td>
|
|
<td><p>Only delete traces created before the given timestamp. <code>None</code> means no
|
|
filtering.</p></td>
|
|
<td>
|
|
<code>None</code>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/tracing/delete_ground_truth.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-7"> 7</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-8"> 8</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-9"> 9</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-7" name="__codelineno-0-7"></a><span class="k">def</span> <span class="nf">delete_ground_truth</span><span class="p">(</span>
|
|
<a id="__codelineno-0-8" name="__codelineno-0-8"></a> <span class="n">conjunctive_tags</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-9" name="__codelineno-0-9"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-10" name="__codelineno-0-10"></a> <span class="n">since</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11"></a> <span class="n">until</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="sd">"""Delete traces matching the given criteria.</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14"></a>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="sd"> Takes the same arguments as `query_ground_truth` but instead of returning them,</span>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="sd"> it simply deletes them.</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="sd"> You can rely on the efficiency of the delete's implementation.</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a><span class="sd"> Examples:</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a><span class="sd"> >>> delete_ground_truth(['train', 'test', 'validation'])</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a><span class="sd"> conjunctive_tags: Single tag or a list of tags which the deleted traces have to</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> match. The relationship between the tags is conjunctive (AND).</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a><span class="sd"> since: Only delete traces created after the given timestamp. `None` means no</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> filtering.</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a><span class="sd"> until: Only delete traces created before the given timestamp. `None` means no</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a><span class="sd"> filtering.</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a> <span class="n">tags</span> <span class="o">=</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="n">conjunctive_tags</span> <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">conjunctive_tags</span><span class="p">,</span> <span class="nb">list</span><span class="p">)</span> <span class="k">else</span> <span class="p">[</span><span class="n">conjunctive_tags</span><span class="p">]</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a> <span class="n">db</span> <span class="o">=</span> <span class="n">get_context</span><span class="p">()</span><span class="o">.</span><span class="n">tracing_database</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="n">items</span><span class="p">,</span> <span class="n">length</span> <span class="o">=</span> <span class="n">db</span><span class="o">.</span><span class="n">query</span><span class="p">(</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="n">conjunctive_tags</span><span class="o">=</span><span class="n">tags</span><span class="p">,</span> <span class="n">until</span><span class="o">=</span><span class="n">until</span><span class="p">,</span> <span class="n">since</span><span class="o">=</span><span class="n">since</span><span class="p">,</span> <span class="n">has_feedback</span><span class="o">=</span><span class="kc">True</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="n">db</span><span class="o">.</span><span class="n">delete_batch</span><span class="p">([</span><span class="n">i</span><span class="o">.</span><span class="n">trace_id</span> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">items</span><span class="p">])</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div><h2 id="tracing-databases">Tracing databases<a class="headerlink" href="#tracing-databases" title="Permanent link">#</a></h2>
|
|
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="great_ai.TracingDatabaseDriver" class="doc doc-heading">
|
|
<code>TracingDatabaseDriver</code>
|
|
|
|
|
|
<a href="#great_ai.TracingDatabaseDriver" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><span title="abc.ABC">ABC</span></code></p>
|
|
|
|
|
|
<p>Interface expected from a database to be used for storing traces.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/persistence/tracing_database_driver.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-10">10</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-11">11</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-12">12</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-13">13</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-14">14</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-15">15</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-16">16</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-17">17</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-18">18</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-19">19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20">20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21">21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22">22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23">23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24">24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25">25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26">26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27">27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28">28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29">29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30">30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31">31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32">32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33">33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34">34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35">35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36">36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37">37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38">38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39">39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40">40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41">41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42">42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43">43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44">44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45">45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46">46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47">47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48">48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67">67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68">68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69">69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70">70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71">71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72">72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73">73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74">74</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-10" name="__codelineno-0-10"></a><span class="k">class</span> <span class="nc">TracingDatabaseDriver</span><span class="p">(</span><span class="n">ABC</span><span class="p">):</span>
|
|
<a id="__codelineno-0-11" name="__codelineno-0-11"></a> <span class="sd">"""Interface expected from a database to be used for storing traces."""</span>
|
|
<a id="__codelineno-0-12" name="__codelineno-0-12"></a>
|
|
<a id="__codelineno-0-13" name="__codelineno-0-13"></a> <span class="n">is_production_ready</span><span class="p">:</span> <span class="nb">bool</span>
|
|
<a id="__codelineno-0-14" name="__codelineno-0-14"></a> <span class="n">initialized</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<a id="__codelineno-0-15" name="__codelineno-0-15"></a>
|
|
<a id="__codelineno-0-16" name="__codelineno-0-16"></a> <span class="nd">@classmethod</span>
|
|
<a id="__codelineno-0-17" name="__codelineno-0-17"></a> <span class="k">def</span> <span class="nf">configure_credentials_from_file</span><span class="p">(</span>
|
|
<a id="__codelineno-0-18" name="__codelineno-0-18"></a> <span class="bp">cls</span><span class="p">,</span>
|
|
<a id="__codelineno-0-19" name="__codelineno-0-19"></a> <span class="n">secrets</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="nb">str</span><span class="p">,</span> <span class="n">ConfigFile</span><span class="p">],</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a> <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">secrets</span><span class="p">,</span> <span class="n">ConfigFile</span><span class="p">):</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a> <span class="n">secrets</span> <span class="o">=</span> <span class="n">ConfigFile</span><span class="p">(</span><span class="n">secrets</span><span class="p">)</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a> <span class="bp">cls</span><span class="o">.</span><span class="n">configure_credentials</span><span class="p">(</span><span class="o">**</span><span class="p">{</span><span class="n">k</span><span class="o">.</span><span class="n">lower</span><span class="p">():</span> <span class="n">v</span> <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">secrets</span><span class="o">.</span><span class="n">items</span><span class="p">()})</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a> <span class="nd">@classmethod</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a> <span class="k">def</span> <span class="nf">configure_credentials</span><span class="p">(</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a> <span class="bp">cls</span><span class="p">,</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a> <span class="bp">cls</span><span class="o">.</span><span class="n">initialized</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">document</span><span class="p">:</span> <span class="n">Trace</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="k">def</span> <span class="nf">save_batch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="n">documents</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">],</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Trace</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a> <span class="k">def</span> <span class="nf">query</span><span class="p">(</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a> <span class="n">skip</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a> <span class="n">take</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="n">conjunctive_filters</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Filter</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a> <span class="n">conjunctive_tags</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="n">until</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="n">since</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a> <span class="n">has_feedback</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a> <span class="n">sort_by</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">SortBy</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">],</span> <span class="nb">int</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">new_version</span><span class="p">:</span> <span class="n">Trace</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="k">pass</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="nd">@abstractmethod</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="k">def</span> <span class="nf">delete_batch</span><span class="p">(</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="n">ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="k">pass</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="great_ai.MongoDbDriver" class="doc doc-heading">
|
|
<code>MongoDbDriver</code>
|
|
|
|
|
|
<a href="#great_ai.MongoDbDriver" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="great_ai.persistence.tracing_database_driver.TracingDatabaseDriver" href="#great_ai.TracingDatabaseDriver">TracingDatabaseDriver</a></code></p>
|
|
|
|
|
|
<p>TracingDatabaseDriver implementation using MongoDB as a backend.</p>
|
|
<p>A production-ready database driver suitable for efficiently handling semi-structured
|
|
data.</p>
|
|
<p>Checkout <a href="https://www.mongodb.com/cloud/atlas/register">MongoDB Atlas</a> for a hosted
|
|
MongoDB solution.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/persistence/mongodb_driver.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-21"> 21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22"> 22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23"> 23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24"> 24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25"> 25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26"> 26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27"> 27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28"> 28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29"> 29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30"> 30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31"> 31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32"> 32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33"> 33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34"> 34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35"> 35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36"> 36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37"> 37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38"> 38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39"> 39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40"> 40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41"> 41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42"> 42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43"> 43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44"> 44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45"> 45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46"> 46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47"> 47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48"> 48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49"> 49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50"> 50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51"> 51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52"> 52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53"> 53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54"> 54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55"> 55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56"> 56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57"> 57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58"> 58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59"> 59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60"> 60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61"> 61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62"> 62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63"> 63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64"> 64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65"> 65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66"> 66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67"> 67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68"> 68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69"> 69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70"> 70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71"> 71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72"> 72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73"> 73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74"> 74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75"> 75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76"> 76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77"> 77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78"> 78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79"> 79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80"> 80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81"> 81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82"> 82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83"> 83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84"> 84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85"> 85</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-86"> 86</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-87"> 87</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-88"> 88</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-89"> 89</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-90"> 90</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-91"> 91</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-92"> 92</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-93"> 93</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-114">114</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-115">115</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-116">116</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-117">117</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-118">118</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-119">119</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-120">120</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-121">121</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-122">122</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-123">123</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-124">124</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-125">125</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-126">126</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-127">127</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-128">128</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-129">129</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-130">130</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-131">131</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-132">132</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-133">133</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-134">134</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-135">135</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-136">136</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-137">137</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-138">138</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-139">139</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-140">140</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-141">141</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-142">142</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-143">143</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-144">144</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-145">145</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-146">146</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-147">147</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-148">148</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-149">149</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-150">150</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-151">151</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-152">152</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-153">153</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-154">154</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-155">155</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-156">156</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-157">157</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-158">158</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-159">159</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-160">160</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-161">161</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-162">162</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-163">163</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-164">164</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-165">165</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-166">166</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-167">167</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-168">168</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-169">169</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-170">170</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-171">171</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-172">172</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-173">173</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-21" name="__codelineno-0-21"></a><span class="k">class</span> <span class="nc">MongoDbDriver</span><span class="p">(</span><span class="n">TracingDatabaseDriver</span><span class="p">):</span>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a> <span class="sd">"""TracingDatabaseDriver implementation using MongoDB as a backend.</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a><span class="sd"> A production-ready database driver suitable for efficiently handling semi-structured</span>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> data.</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a><span class="sd"> Checkout [MongoDB Atlas](https://www.mongodb.com/cloud/atlas/register) for a hosted</span>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a><span class="sd"> MongoDB solution.</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a> <span class="n">is_production_ready</span> <span class="o">=</span> <span class="kc">True</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a> <span class="n">mongo_connection_string</span><span class="p">:</span> <span class="nb">str</span>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="n">mongo_database</span><span class="p">:</span> <span class="nb">str</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a> <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="s2">"Please configure the MongoDB access options by calling "</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="s2">"MongoDbDriver.configure_credentials"</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">create_index</span><span class="p">(</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="p">[(</span><span class="s2">"tags"</span><span class="p">,</span> <span class="n">ASCENDING</span><span class="p">),</span> <span class="p">(</span><span class="s2">"created"</span><span class="p">,</span> <span class="n">DESCENDING</span><span class="p">)],</span> <span class="n">background</span><span class="o">=</span><span class="kc">True</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="nd">@classmethod</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a> <span class="k">def</span> <span class="nf">configure_credentials</span><span class="p">(</span> <span class="c1"># type: ignore</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a> <span class="bp">cls</span><span class="p">,</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a> <span class="n">mongo_connection_string</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="n">mongo_database</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="o">**</span><span class="n">_</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a> <span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a> <span class="sd">"""Configure the connection details for MongoDB.</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a><span class="sd"> mongo_connection_string: For example:</span>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="sd"> 'mongodb://my_user:my_pass@localhost:27017'</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="sd"> mongo_database: Name of the database to use. If doesn't exist, it is</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="sd"> created and initialised.</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="bp">cls</span><span class="o">.</span><span class="n">mongo_connection_string</span> <span class="o">=</span> <span class="n">mongo_connection_string</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="bp">cls</span><span class="o">.</span><span class="n">mongo_database</span> <span class="o">=</span> <span class="n">mongo_database</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">configure_credentials</span><span class="p">()</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trace</span><span class="p">:</span> <span class="n">Trace</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a> <span class="n">serialized</span> <span class="o">=</span> <span class="n">trace</span><span class="o">.</span><span class="n">to_flat_dict</span><span class="p">()</span>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="n">serialized</span><span class="p">[</span><span class="s2">"_id"</span><span class="p">]</span> <span class="o">=</span> <span class="n">trace</span><span class="o">.</span><span class="n">trace_id</span>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="k">return</span> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">insert_one</span><span class="p">(</span><span class="n">serialized</span><span class="p">)</span><span class="o">.</span><span class="n">inserted_id</span>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="k">def</span> <span class="nf">save_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">documents</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">])</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a> <span class="n">serialized</span> <span class="o">=</span> <span class="p">[</span><span class="n">d</span><span class="o">.</span><span class="n">to_flat_dict</span><span class="p">()</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">documents</span><span class="p">]</span>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="k">for</span> <span class="n">s</span> <span class="ow">in</span> <span class="n">serialized</span><span class="p">:</span>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="n">s</span><span class="p">[</span><span class="s2">"_id"</span><span class="p">]</span> <span class="o">=</span> <span class="n">s</span><span class="p">[</span><span class="s2">"trace_id"</span><span class="p">]</span>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="k">return</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a> <span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">insert_many</span><span class="p">(</span><span class="n">serialized</span><span class="p">,</span> <span class="n">ordered</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="o">.</span><span class="n">inserted_ids</span>
|
|
<a id="__codelineno-0-86" name="__codelineno-0-86"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-87" name="__codelineno-0-87"></a>
|
|
<a id="__codelineno-0-88" name="__codelineno-0-88"></a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Trace</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-89" name="__codelineno-0-89"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="n">value</span> <span class="o">=</span> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">find_one</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
|
|
<a id="__codelineno-0-91" name="__codelineno-0-91"></a>
|
|
<a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="k">if</span> <span class="n">value</span><span class="p">:</span>
|
|
<a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="n">value</span> <span class="o">=</span> <span class="n">Trace</span><span class="o">.</span><span class="n">parse_obj</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<a id="__codelineno-0-94" name="__codelineno-0-94"></a>
|
|
<a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="k">return</span> <span class="n">value</span>
|
|
<a id="__codelineno-0-96" name="__codelineno-0-96"></a>
|
|
<a id="__codelineno-0-97" name="__codelineno-0-97"></a> <span class="k">def</span> <span class="nf">_get_operator</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">filter</span><span class="p">:</span> <span class="n">Filter</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<a id="__codelineno-0-98" name="__codelineno-0-98"></a> <span class="k">if</span> <span class="nb">filter</span><span class="o">.</span><span class="n">operator</span> <span class="o">==</span> <span class="s2">"contains"</span> <span class="ow">and</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="nb">filter</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
|
|
<a id="__codelineno-0-99" name="__codelineno-0-99"></a> <span class="k">return</span> <span class="n">operator_mapping</span><span class="p">[</span><span class="s2">"="</span><span class="p">]</span>
|
|
<a id="__codelineno-0-100" name="__codelineno-0-100"></a> <span class="k">return</span> <span class="n">operator_mapping</span><span class="p">[</span><span class="nb">filter</span><span class="o">.</span><span class="n">operator</span><span class="p">]</span>
|
|
<a id="__codelineno-0-101" name="__codelineno-0-101"></a>
|
|
<a id="__codelineno-0-102" name="__codelineno-0-102"></a> <span class="k">def</span> <span class="nf">query</span><span class="p">(</span>
|
|
<a id="__codelineno-0-103" name="__codelineno-0-103"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-104" name="__codelineno-0-104"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="n">skip</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-106" name="__codelineno-0-106"></a> <span class="n">take</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="n">conjunctive_filters</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Filter</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-108" name="__codelineno-0-108"></a> <span class="n">conjunctive_tags</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="n">since</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-110" name="__codelineno-0-110"></a> <span class="n">until</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="n">has_feedback</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-112" name="__codelineno-0-112"></a> <span class="n">sort_by</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">SortBy</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">],</span> <span class="nb">int</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-114" name="__codelineno-0-114"></a>
|
|
<a id="__codelineno-0-115" name="__codelineno-0-115"></a> <span class="n">query</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span>
|
|
<a id="__codelineno-0-116" name="__codelineno-0-116"></a> <span class="s2">"filter"</span><span class="p">:</span> <span class="p">{},</span>
|
|
<a id="__codelineno-0-117" name="__codelineno-0-117"></a> <span class="p">}</span>
|
|
<a id="__codelineno-0-118" name="__codelineno-0-118"></a>
|
|
<a id="__codelineno-0-119" name="__codelineno-0-119"></a> <span class="n">and_query</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<a id="__codelineno-0-120" name="__codelineno-0-120"></a> <span class="n">and_query</span><span class="o">.</span><span class="n">extend</span><span class="p">({</span><span class="s2">"tags"</span><span class="p">:</span> <span class="n">tag</span><span class="p">}</span> <span class="k">for</span> <span class="n">tag</span> <span class="ow">in</span> <span class="n">conjunctive_tags</span><span class="p">)</span>
|
|
<a id="__codelineno-0-121" name="__codelineno-0-121"></a> <span class="n">and_query</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span>
|
|
<a id="__codelineno-0-122" name="__codelineno-0-122"></a> <span class="p">{</span><span class="n">f</span><span class="o">.</span><span class="n">property</span><span class="p">:</span> <span class="p">{</span><span class="bp">self</span><span class="o">.</span><span class="n">_get_operator</span><span class="p">(</span><span class="n">f</span><span class="p">):</span> <span class="n">f</span><span class="o">.</span><span class="n">value</span><span class="p">}}</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">conjunctive_filters</span>
|
|
<a id="__codelineno-0-123" name="__codelineno-0-123"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-124" name="__codelineno-0-124"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">and_query</span><span class="p">:</span>
|
|
<a id="__codelineno-0-125" name="__codelineno-0-125"></a> <span class="n">and_query</span><span class="o">.</span><span class="n">append</span><span class="p">({})</span>
|
|
<a id="__codelineno-0-126" name="__codelineno-0-126"></a>
|
|
<a id="__codelineno-0-127" name="__codelineno-0-127"></a> <span class="k">if</span> <span class="n">since</span><span class="p">:</span>
|
|
<a id="__codelineno-0-128" name="__codelineno-0-128"></a> <span class="n">and_query</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">"created"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"$gte"</span><span class="p">:</span> <span class="n">since</span><span class="p">}})</span>
|
|
<a id="__codelineno-0-129" name="__codelineno-0-129"></a>
|
|
<a id="__codelineno-0-130" name="__codelineno-0-130"></a> <span class="k">if</span> <span class="n">until</span><span class="p">:</span>
|
|
<a id="__codelineno-0-131" name="__codelineno-0-131"></a> <span class="n">and_query</span><span class="o">.</span><span class="n">append</span><span class="p">({</span><span class="s2">"created"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"$lte"</span><span class="p">:</span> <span class="n">until</span><span class="p">}})</span>
|
|
<a id="__codelineno-0-132" name="__codelineno-0-132"></a>
|
|
<a id="__codelineno-0-133" name="__codelineno-0-133"></a> <span class="k">if</span> <span class="n">has_feedback</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-134" name="__codelineno-0-134"></a> <span class="n">and_query</span><span class="o">.</span><span class="n">append</span><span class="p">(</span>
|
|
<a id="__codelineno-0-135" name="__codelineno-0-135"></a> <span class="p">{</span><span class="s2">"feedback"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"$ne"</span><span class="p">:</span> <span class="kc">None</span><span class="p">}}</span> <span class="k">if</span> <span class="n">has_feedback</span> <span class="k">else</span> <span class="p">{</span><span class="s2">"feedback"</span><span class="p">:</span> <span class="kc">None</span><span class="p">}</span>
|
|
<a id="__codelineno-0-136" name="__codelineno-0-136"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-137" name="__codelineno-0-137"></a> <span class="n">query</span><span class="p">[</span><span class="s2">"filter"</span><span class="p">][</span><span class="s2">"$and"</span><span class="p">]</span> <span class="o">=</span> <span class="n">and_query</span>
|
|
<a id="__codelineno-0-138" name="__codelineno-0-138"></a>
|
|
<a id="__codelineno-0-139" name="__codelineno-0-139"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-140" name="__codelineno-0-140"></a> <span class="n">count</span> <span class="o">=</span> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">count_documents</span><span class="p">(</span><span class="o">**</span><span class="n">query</span><span class="p">)</span>
|
|
<a id="__codelineno-0-141" name="__codelineno-0-141"></a>
|
|
<a id="__codelineno-0-142" name="__codelineno-0-142"></a> <span class="k">if</span> <span class="n">skip</span><span class="p">:</span>
|
|
<a id="__codelineno-0-143" name="__codelineno-0-143"></a> <span class="n">query</span><span class="p">[</span><span class="s2">"skip"</span><span class="p">]</span> <span class="o">=</span> <span class="n">skip</span>
|
|
<a id="__codelineno-0-144" name="__codelineno-0-144"></a>
|
|
<a id="__codelineno-0-145" name="__codelineno-0-145"></a> <span class="k">if</span> <span class="n">take</span><span class="p">:</span>
|
|
<a id="__codelineno-0-146" name="__codelineno-0-146"></a> <span class="n">query</span><span class="p">[</span><span class="s2">"limit"</span><span class="p">]</span> <span class="o">=</span> <span class="n">take</span>
|
|
<a id="__codelineno-0-147" name="__codelineno-0-147"></a>
|
|
<a id="__codelineno-0-148" name="__codelineno-0-148"></a> <span class="n">query</span><span class="p">[</span><span class="s2">"sort"</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
|
|
<a id="__codelineno-0-149" name="__codelineno-0-149"></a> <span class="p">(</span><span class="n">col</span><span class="o">.</span><span class="n">column_id</span><span class="p">,</span> <span class="mi">1</span> <span class="k">if</span> <span class="n">col</span><span class="o">.</span><span class="n">direction</span> <span class="o">==</span> <span class="s2">"asc"</span> <span class="k">else</span> <span class="o">-</span><span class="mi">1</span><span class="p">)</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">sort_by</span>
|
|
<a id="__codelineno-0-150" name="__codelineno-0-150"></a> <span class="p">]</span>
|
|
<a id="__codelineno-0-151" name="__codelineno-0-151"></a>
|
|
<a id="__codelineno-0-152" name="__codelineno-0-152"></a> <span class="k">with</span> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="o">**</span><span class="n">query</span><span class="p">)</span> <span class="k">as</span> <span class="n">cursor</span><span class="p">:</span>
|
|
<a id="__codelineno-0-153" name="__codelineno-0-153"></a> <span class="n">documents</span> <span class="o">=</span> <span class="p">[</span><span class="n">Trace</span><span class="p">[</span><span class="n">Any</span><span class="p">]</span><span class="o">.</span><span class="n">parse_obj</span><span class="p">(</span><span class="n">t</span><span class="p">)</span> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="n">cursor</span><span class="p">]</span>
|
|
<a id="__codelineno-0-154" name="__codelineno-0-154"></a> <span class="k">return</span> <span class="n">documents</span><span class="p">,</span> <span class="n">count</span>
|
|
<a id="__codelineno-0-155" name="__codelineno-0-155"></a>
|
|
<a id="__codelineno-0-156" name="__codelineno-0-156"></a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">new_version</span><span class="p">:</span> <span class="n">Trace</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-157" name="__codelineno-0-157"></a> <span class="n">serialized</span> <span class="o">=</span> <span class="n">new_version</span><span class="o">.</span><span class="n">to_flat_dict</span><span class="p">()</span>
|
|
<a id="__codelineno-0-158" name="__codelineno-0-158"></a> <span class="n">serialized</span><span class="p">[</span><span class="s2">"_id"</span><span class="p">]</span> <span class="o">=</span> <span class="n">new_version</span><span class="o">.</span><span class="n">trace_id</span>
|
|
<a id="__codelineno-0-159" name="__codelineno-0-159"></a>
|
|
<a id="__codelineno-0-160" name="__codelineno-0-160"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-161" name="__codelineno-0-161"></a> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">update_one</span><span class="p">({</span><span class="s2">"_id"</span><span class="p">:</span> <span class="nb">id</span><span class="p">},</span> <span class="n">serialized</span><span class="p">)</span>
|
|
<a id="__codelineno-0-162" name="__codelineno-0-162"></a>
|
|
<a id="__codelineno-0-163" name="__codelineno-0-163"></a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-164" name="__codelineno-0-164"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-165" name="__codelineno-0-165"></a> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">delete_one</span><span class="p">({</span><span class="s2">"_id"</span><span class="p">:</span> <span class="nb">id</span><span class="p">})</span>
|
|
<a id="__codelineno-0-166" name="__codelineno-0-166"></a>
|
|
<a id="__codelineno-0-167" name="__codelineno-0-167"></a> <span class="k">def</span> <span class="nf">delete_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-168" name="__codelineno-0-168"></a> <span class="k">with</span> <span class="n">MongoClient</span><span class="p">[</span><span class="n">Any</span><span class="p">](</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_connection_string</span><span class="p">)</span> <span class="k">as</span> <span class="n">client</span><span class="p">:</span>
|
|
<a id="__codelineno-0-169" name="__codelineno-0-169"></a> <span class="k">for</span> <span class="n">c</span> <span class="ow">in</span> <span class="n">chunk</span><span class="p">(</span>
|
|
<a id="__codelineno-0-170" name="__codelineno-0-170"></a> <span class="n">ids</span><span class="p">,</span> <span class="n">chunk_size</span><span class="o">=</span><span class="mi">10000</span>
|
|
<a id="__codelineno-0-171" name="__codelineno-0-171"></a> <span class="p">):</span> <span class="c1"># avoid: 'delete' command document too large</span>
|
|
<a id="__codelineno-0-172" name="__codelineno-0-172"></a> <span class="n">delete_filter</span> <span class="o">=</span> <span class="p">{</span><span class="s2">"_id"</span><span class="p">:</span> <span class="p">{</span><span class="s2">"$in"</span><span class="p">:</span> <span class="n">c</span><span class="p">}}</span>
|
|
<a id="__codelineno-0-173" name="__codelineno-0-173"></a> <span class="n">client</span><span class="p">[</span><span class="bp">self</span><span class="o">.</span><span class="n">mongo_database</span><span class="p">]</span><span class="o">.</span><span class="n">traces</span><span class="o">.</span><span class="n">delete_many</span><span class="p">(</span><span class="n">delete_filter</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<div class="doc doc-object doc-function">
|
|
|
|
|
|
|
|
<h4 id="great_ai.persistence.mongodb_driver.MongoDbDriver.configure_credentials" class="doc doc-heading">
|
|
<code class="highlight language-python"><span class="n">configure_credentials</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">mongo_connection_string</span><span class="p">,</span> <span class="n">mongo_database</span><span class="p">,</span> <span class="o">**</span><span class="n">_</span><span class="p">)</span></code>
|
|
|
|
<span class="doc doc-labels">
|
|
<small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
|
|
</span>
|
|
|
|
<a href="#great_ai.persistence.mongodb_driver.MongoDbDriver.configure_credentials" class="headerlink" title="Permanent link">#</a></h4>
|
|
|
|
|
|
<div class="doc doc-contents ">
|
|
|
|
<p>Configure the connection details for MongoDB.</p>
|
|
|
|
<p><strong>Parameters:</strong></p>
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Name</th>
|
|
<th>Type</th>
|
|
<th>Description</th>
|
|
<th>Default</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td><code>mongo_connection_string</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>For example:
|
|
'mongodb://my_user:my_pass@localhost:27017'</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td><code>mongo_database</code></td>
|
|
<td>
|
|
<code>str</code>
|
|
</td>
|
|
<td><p>Name of the database to use. If doesn't exist, it is
|
|
created and initialised.</p></td>
|
|
<td>
|
|
<em>required</em>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/persistence/mongodb_driver.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-49">49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50">50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51">51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52">52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53">53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54">54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55">55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56">56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57">57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58">58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59">59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60">60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61">61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62">62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63">63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64">64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65">65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66">66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67">67</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="nd">@classmethod</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="k">def</span> <span class="nf">configure_credentials</span><span class="p">(</span> <span class="c1"># type: ignore</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a> <span class="bp">cls</span><span class="p">,</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a> <span class="n">mongo_connection_string</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="n">mongo_database</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="o">**</span><span class="n">_</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a> <span class="sd">"""Configure the connection details for MongoDB.</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd"> Args:</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a><span class="sd"> mongo_connection_string: For example:</span>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="sd"> 'mongodb://my_user:my_pass@localhost:27017'</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="sd"> mongo_database: Name of the database to use. If doesn't exist, it is</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="sd"> created and initialised.</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a> <span class="bp">cls</span><span class="o">.</span><span class="n">mongo_connection_string</span> <span class="o">=</span> <span class="n">mongo_connection_string</span>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="bp">cls</span><span class="o">.</span><span class="n">mongo_database</span> <span class="o">=</span> <span class="n">mongo_database</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">configure_credentials</span><span class="p">()</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
</div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div class="doc doc-object doc-class">
|
|
|
|
|
|
|
|
<h3 id="great_ai.ParallelTinyDbDriver" class="doc doc-heading">
|
|
<code>ParallelTinyDbDriver</code>
|
|
|
|
|
|
<a href="#great_ai.ParallelTinyDbDriver" class="headerlink" title="Permanent link">#</a></h3>
|
|
|
|
|
|
<div class="doc doc-contents first">
|
|
<p class="doc doc-class-bases">
|
|
Bases: <code><a class="autorefs autorefs-internal" title="great_ai.persistence.tracing_database_driver.TracingDatabaseDriver" href="#great_ai.TracingDatabaseDriver">TracingDatabaseDriver</a></code></p>
|
|
|
|
|
|
<p>TracingDatabaseDriver with TinyDB as a backend.</p>
|
|
<p>Saves the database as a JSON into a single file. Highly inefficient on inserting,
|
|
not advised for production use.</p>
|
|
<p>A multiprocessing lock protects the database file to avoid parallelisation issues.</p>
|
|
|
|
|
|
<details class="quote">
|
|
<summary>Source code in <code>great_ai/persistence/parallel_tinydb_driver.py</code></summary>
|
|
<div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-19"> 19</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-20"> 20</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-21"> 21</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-22"> 22</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-23"> 23</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-24"> 24</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-25"> 25</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-26"> 26</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-27"> 27</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-28"> 28</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-29"> 29</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-30"> 30</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-31"> 31</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-32"> 32</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-33"> 33</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-34"> 34</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-35"> 35</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-36"> 36</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-37"> 37</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-38"> 38</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-39"> 39</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-40"> 40</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-41"> 41</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-42"> 42</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-43"> 43</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-44"> 44</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-45"> 45</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-46"> 46</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-47"> 47</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-48"> 48</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-49"> 49</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-50"> 50</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-51"> 51</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-52"> 52</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-53"> 53</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-54"> 54</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-55"> 55</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-56"> 56</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-57"> 57</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-58"> 58</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-59"> 59</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-60"> 60</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-61"> 61</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-62"> 62</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-63"> 63</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-64"> 64</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-65"> 65</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-66"> 66</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-67"> 67</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-68"> 68</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-69"> 69</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-70"> 70</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-71"> 71</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-72"> 72</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-73"> 73</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-74"> 74</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-75"> 75</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-76"> 76</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-77"> 77</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-78"> 78</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-79"> 79</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-80"> 80</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-81"> 81</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-82"> 82</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-83"> 83</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-84"> 84</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-85"> 85</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-86"> 86</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-87"> 87</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-88"> 88</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-89"> 89</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-90"> 90</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-91"> 91</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-92"> 92</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-93"> 93</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-94"> 94</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-95"> 95</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-96"> 96</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-97"> 97</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-98"> 98</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-100">100</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-101">101</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-102">102</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-103">103</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-104">104</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-105">105</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-106">106</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-107">107</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-108">108</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-109">109</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-110">110</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-111">111</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-112">112</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-113">113</a></span>
|
|
<span class="normal"><a href="#__codelineno-0-114">114</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-19" name="__codelineno-0-19"></a><span class="k">class</span> <span class="nc">ParallelTinyDbDriver</span><span class="p">(</span><span class="n">TracingDatabaseDriver</span><span class="p">):</span>
|
|
<a id="__codelineno-0-20" name="__codelineno-0-20"></a> <span class="sd">"""TracingDatabaseDriver with TinyDB as a backend.</span>
|
|
<a id="__codelineno-0-21" name="__codelineno-0-21"></a>
|
|
<a id="__codelineno-0-22" name="__codelineno-0-22"></a><span class="sd"> Saves the database as a JSON into a single file. Highly inefficient on inserting,</span>
|
|
<a id="__codelineno-0-23" name="__codelineno-0-23"></a><span class="sd"> not advised for production use.</span>
|
|
<a id="__codelineno-0-24" name="__codelineno-0-24"></a>
|
|
<a id="__codelineno-0-25" name="__codelineno-0-25"></a><span class="sd"> A multiprocessing lock protects the database file to avoid parallelisation issues.</span>
|
|
<a id="__codelineno-0-26" name="__codelineno-0-26"></a><span class="sd"> """</span>
|
|
<a id="__codelineno-0-27" name="__codelineno-0-27"></a>
|
|
<a id="__codelineno-0-28" name="__codelineno-0-28"></a> <span class="n">is_production_ready</span> <span class="o">=</span> <span class="kc">False</span>
|
|
<a id="__codelineno-0-29" name="__codelineno-0-29"></a> <span class="n">path_to_db</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">DEFAULT_TRACING_DB_FILENAME</span><span class="p">)</span>
|
|
<a id="__codelineno-0-30" name="__codelineno-0-30"></a>
|
|
<a id="__codelineno-0-31" name="__codelineno-0-31"></a> <span class="k">def</span> <span class="nf">save</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">trace</span><span class="p">:</span> <span class="n">Trace</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span>
|
|
<a id="__codelineno-0-32" name="__codelineno-0-32"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_safe_execute</span><span class="p">(</span><span class="k">lambda</span> <span class="n">db</span><span class="p">:</span> <span class="n">db</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">trace</span><span class="o">.</span><span class="n">dict</span><span class="p">()))</span>
|
|
<a id="__codelineno-0-33" name="__codelineno-0-33"></a>
|
|
<a id="__codelineno-0-34" name="__codelineno-0-34"></a> <span class="k">def</span> <span class="nf">save_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">documents</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">])</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-35" name="__codelineno-0-35"></a> <span class="n">traces</span> <span class="o">=</span> <span class="p">[</span><span class="n">d</span><span class="o">.</span><span class="n">dict</span><span class="p">()</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">documents</span><span class="p">]</span>
|
|
<a id="__codelineno-0-36" name="__codelineno-0-36"></a> <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_safe_execute</span><span class="p">(</span><span class="k">lambda</span> <span class="n">db</span><span class="p">:</span> <span class="n">db</span><span class="o">.</span><span class="n">insert_multiple</span><span class="p">(</span><span class="n">traces</span><span class="p">))</span>
|
|
<a id="__codelineno-0-37" name="__codelineno-0-37"></a>
|
|
<a id="__codelineno-0-38" name="__codelineno-0-38"></a> <span class="k">def</span> <span class="nf">get</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Trace</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-39" name="__codelineno-0-39"></a> <span class="n">value</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_safe_execute</span><span class="p">(</span><span class="k">lambda</span> <span class="n">db</span><span class="p">:</span> <span class="n">db</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="k">lambda</span> <span class="n">d</span><span class="p">:</span> <span class="n">d</span><span class="p">[</span><span class="s2">"trace_id"</span><span class="p">]</span> <span class="o">==</span> <span class="nb">id</span><span class="p">))</span>
|
|
<a id="__codelineno-0-40" name="__codelineno-0-40"></a> <span class="k">if</span> <span class="n">value</span><span class="p">:</span>
|
|
<a id="__codelineno-0-41" name="__codelineno-0-41"></a> <span class="n">value</span> <span class="o">=</span> <span class="n">Trace</span><span class="o">.</span><span class="n">parse_obj</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
|
|
<a id="__codelineno-0-42" name="__codelineno-0-42"></a> <span class="k">return</span> <span class="n">value</span>
|
|
<a id="__codelineno-0-43" name="__codelineno-0-43"></a>
|
|
<a id="__codelineno-0-44" name="__codelineno-0-44"></a> <span class="k">def</span> <span class="nf">query</span><span class="p">(</span>
|
|
<a id="__codelineno-0-45" name="__codelineno-0-45"></a> <span class="bp">self</span><span class="p">,</span>
|
|
<a id="__codelineno-0-46" name="__codelineno-0-46"></a> <span class="o">*</span><span class="p">,</span>
|
|
<a id="__codelineno-0-47" name="__codelineno-0-47"></a> <span class="n">skip</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span><span class="p">,</span>
|
|
<a id="__codelineno-0-48" name="__codelineno-0-48"></a> <span class="n">take</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">int</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-49" name="__codelineno-0-49"></a> <span class="n">conjunctive_filters</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">Filter</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-50" name="__codelineno-0-50"></a> <span class="n">conjunctive_tags</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">[],</span>
|
|
<a id="__codelineno-0-51" name="__codelineno-0-51"></a> <span class="n">since</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-52" name="__codelineno-0-52"></a> <span class="n">until</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">datetime</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-53" name="__codelineno-0-53"></a> <span class="n">has_feedback</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="nb">bool</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span>
|
|
<a id="__codelineno-0-54" name="__codelineno-0-54"></a> <span class="n">sort_by</span><span class="p">:</span> <span class="n">Sequence</span><span class="p">[</span><span class="n">SortBy</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
|
|
<a id="__codelineno-0-55" name="__codelineno-0-55"></a> <span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">],</span> <span class="nb">int</span><span class="p">]:</span>
|
|
<a id="__codelineno-0-56" name="__codelineno-0-56"></a> <span class="k">def</span> <span class="nf">does_match</span><span class="p">(</span><span class="n">d</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span>
|
|
<a id="__codelineno-0-57" name="__codelineno-0-57"></a> <span class="k">return</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-58" name="__codelineno-0-58"></a> <span class="ow">not</span> <span class="nb">set</span><span class="p">(</span><span class="n">conjunctive_tags</span><span class="p">)</span> <span class="o">-</span> <span class="nb">set</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s2">"tags"</span><span class="p">])</span>
|
|
<a id="__codelineno-0-59" name="__codelineno-0-59"></a> <span class="ow">and</span> <span class="p">(</span><span class="n">since</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s2">"created"</span><span class="p">])</span> <span class="o">>=</span> <span class="n">since</span><span class="p">)</span>
|
|
<a id="__codelineno-0-60" name="__codelineno-0-60"></a> <span class="ow">and</span> <span class="p">(</span><span class="n">until</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">datetime</span><span class="o">.</span><span class="n">fromisoformat</span><span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s2">"created"</span><span class="p">])</span> <span class="o"><=</span> <span class="n">until</span><span class="p">)</span>
|
|
<a id="__codelineno-0-61" name="__codelineno-0-61"></a> <span class="ow">and</span> <span class="p">(</span>
|
|
<a id="__codelineno-0-62" name="__codelineno-0-62"></a> <span class="n">has_feedback</span> <span class="ow">is</span> <span class="kc">None</span> <span class="ow">or</span> <span class="n">has_feedback</span> <span class="o">==</span> <span class="p">(</span><span class="n">d</span><span class="p">[</span><span class="s2">"feedback"</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">)</span>
|
|
<a id="__codelineno-0-63" name="__codelineno-0-63"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-64" name="__codelineno-0-64"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-65" name="__codelineno-0-65"></a>
|
|
<a id="__codelineno-0-66" name="__codelineno-0-66"></a> <span class="n">documents</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Trace</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
|
|
<a id="__codelineno-0-67" name="__codelineno-0-67"></a> <span class="n">Trace</span><span class="o">.</span><span class="n">parse_obj</span><span class="p">(</span><span class="n">t</span><span class="p">)</span>
|
|
<a id="__codelineno-0-68" name="__codelineno-0-68"></a> <span class="k">for</span> <span class="n">t</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_safe_execute</span><span class="p">(</span><span class="k">lambda</span> <span class="n">db</span><span class="p">:</span> <span class="n">db</span><span class="o">.</span><span class="n">search</span><span class="p">(</span><span class="n">does_match</span><span class="p">))</span>
|
|
<a id="__codelineno-0-69" name="__codelineno-0-69"></a> <span class="p">]</span>
|
|
<a id="__codelineno-0-70" name="__codelineno-0-70"></a>
|
|
<a id="__codelineno-0-71" name="__codelineno-0-71"></a> <span class="k">if</span> <span class="ow">not</span> <span class="n">documents</span><span class="p">:</span>
|
|
<a id="__codelineno-0-72" name="__codelineno-0-72"></a> <span class="k">return</span> <span class="p">[],</span> <span class="mi">0</span>
|
|
<a id="__codelineno-0-73" name="__codelineno-0-73"></a>
|
|
<a id="__codelineno-0-74" name="__codelineno-0-74"></a> <span class="n">df</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">([</span><span class="n">d</span><span class="o">.</span><span class="n">to_flat_dict</span><span class="p">()</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">documents</span><span class="p">])</span>
|
|
<a id="__codelineno-0-75" name="__codelineno-0-75"></a>
|
|
<a id="__codelineno-0-76" name="__codelineno-0-76"></a> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">conjunctive_filters</span><span class="p">:</span>
|
|
<a id="__codelineno-0-77" name="__codelineno-0-77"></a> <span class="n">operator</span> <span class="o">=</span> <span class="n">f</span><span class="o">.</span><span class="n">operator</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span>
|
|
<a id="__codelineno-0-78" name="__codelineno-0-78"></a> <span class="k">if</span> <span class="n">operator</span> <span class="ow">in</span> <span class="n">operator_mapping</span><span class="p">:</span>
|
|
<a id="__codelineno-0-79" name="__codelineno-0-79"></a> <span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span>
|
|
<a id="__codelineno-0-80" name="__codelineno-0-80"></a> <span class="nb">getattr</span><span class="p">(</span><span class="n">df</span><span class="p">[</span><span class="n">f</span><span class="o">.</span><span class="n">property</span><span class="p">],</span> <span class="n">operator_mapping</span><span class="p">[</span><span class="n">f</span><span class="o">.</span><span class="n">operator</span><span class="p">])(</span><span class="n">f</span><span class="o">.</span><span class="n">value</span><span class="p">)</span>
|
|
<a id="__codelineno-0-81" name="__codelineno-0-81"></a> <span class="p">]</span>
|
|
<a id="__codelineno-0-82" name="__codelineno-0-82"></a> <span class="k">elif</span> <span class="n">operator</span> <span class="o">==</span> <span class="s2">"contains"</span><span class="p">:</span>
|
|
<a id="__codelineno-0-83" name="__codelineno-0-83"></a> <span class="n">df</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">loc</span><span class="p">[</span><span class="n">df</span><span class="p">[</span><span class="n">f</span><span class="o">.</span><span class="n">property</span><span class="p">]</span><span class="o">.</span><span class="n">str</span><span class="o">.</span><span class="n">contains</span><span class="p">(</span><span class="n">f</span><span class="o">.</span><span class="n">value</span><span class="p">,</span> <span class="n">case</span><span class="o">=</span><span class="kc">False</span><span class="p">)]</span>
|
|
<a id="__codelineno-0-84" name="__codelineno-0-84"></a>
|
|
<a id="__codelineno-0-85" name="__codelineno-0-85"></a> <span class="k">if</span> <span class="n">sort_by</span><span class="p">:</span>
|
|
<a id="__codelineno-0-86" name="__codelineno-0-86"></a> <span class="n">df</span><span class="o">.</span><span class="n">sort_values</span><span class="p">(</span>
|
|
<a id="__codelineno-0-87" name="__codelineno-0-87"></a> <span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">column_id</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">sort_by</span><span class="p">],</span>
|
|
<a id="__codelineno-0-88" name="__codelineno-0-88"></a> <span class="n">ascending</span><span class="o">=</span><span class="p">[</span><span class="n">col</span><span class="o">.</span><span class="n">direction</span> <span class="o">==</span> <span class="s2">"asc"</span> <span class="k">for</span> <span class="n">col</span> <span class="ow">in</span> <span class="n">sort_by</span><span class="p">],</span>
|
|
<a id="__codelineno-0-89" name="__codelineno-0-89"></a> <span class="n">inplace</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
|
|
<a id="__codelineno-0-90" name="__codelineno-0-90"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-91" name="__codelineno-0-91"></a>
|
|
<a id="__codelineno-0-92" name="__codelineno-0-92"></a> <span class="n">count</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">df</span><span class="p">)</span>
|
|
<a id="__codelineno-0-93" name="__codelineno-0-93"></a> <span class="n">result</span> <span class="o">=</span> <span class="n">df</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">skip</span><span class="p">:]</span> <span class="k">if</span> <span class="n">take</span> <span class="ow">is</span> <span class="kc">None</span> <span class="k">else</span> <span class="n">df</span><span class="o">.</span><span class="n">iloc</span><span class="p">[</span><span class="n">skip</span> <span class="p">:</span> <span class="n">skip</span> <span class="o">+</span> <span class="n">take</span><span class="p">]</span>
|
|
<a id="__codelineno-0-94" name="__codelineno-0-94"></a> <span class="k">return</span> <span class="p">[</span>
|
|
<a id="__codelineno-0-95" name="__codelineno-0-95"></a> <span class="nb">next</span><span class="p">(</span><span class="n">d</span> <span class="k">for</span> <span class="n">d</span> <span class="ow">in</span> <span class="n">documents</span> <span class="k">if</span> <span class="n">d</span><span class="o">.</span><span class="n">trace_id</span> <span class="o">==</span> <span class="n">trace_id</span><span class="p">)</span>
|
|
<a id="__codelineno-0-96" name="__codelineno-0-96"></a> <span class="k">for</span> <span class="n">trace_id</span> <span class="ow">in</span> <span class="n">result</span><span class="p">[</span><span class="s2">"trace_id"</span><span class="p">]</span>
|
|
<a id="__codelineno-0-97" name="__codelineno-0-97"></a> <span class="p">],</span> <span class="n">count</span>
|
|
<a id="__codelineno-0-98" name="__codelineno-0-98"></a>
|
|
<a id="__codelineno-0-99" name="__codelineno-0-99"></a> <span class="k">def</span> <span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">new_version</span><span class="p">:</span> <span class="n">Trace</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-100" name="__codelineno-0-100"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_safe_execute</span><span class="p">(</span>
|
|
<a id="__codelineno-0-101" name="__codelineno-0-101"></a> <span class="k">lambda</span> <span class="n">db</span><span class="p">:</span> <span class="n">db</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">new_version</span><span class="o">.</span><span class="n">dict</span><span class="p">(),</span> <span class="k">lambda</span> <span class="n">d</span><span class="p">:</span> <span class="n">d</span><span class="p">[</span><span class="s2">"trace_id"</span><span class="p">]</span> <span class="o">==</span> <span class="nb">id</span><span class="p">)</span>
|
|
<a id="__codelineno-0-102" name="__codelineno-0-102"></a> <span class="p">)</span>
|
|
<a id="__codelineno-0-103" name="__codelineno-0-103"></a>
|
|
<a id="__codelineno-0-104" name="__codelineno-0-104"></a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-105" name="__codelineno-0-105"></a> <span class="bp">self</span><span class="o">.</span><span class="n">_safe_execute</span><span class="p">(</span><span class="k">lambda</span> <span class="n">db</span><span class="p">:</span> <span class="n">db</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="k">lambda</span> <span class="n">d</span><span class="p">:</span> <span class="n">d</span><span class="p">[</span><span class="s2">"trace_id"</span><span class="p">]</span> <span class="o">==</span> <span class="nb">id</span><span class="p">))</span>
|
|
<a id="__codelineno-0-106" name="__codelineno-0-106"></a>
|
|
<a id="__codelineno-0-107" name="__codelineno-0-107"></a> <span class="k">def</span> <span class="nf">delete_batch</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ids</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<a id="__codelineno-0-108" name="__codelineno-0-108"></a> <span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="n">ids</span><span class="p">:</span>
|
|
<a id="__codelineno-0-109" name="__codelineno-0-109"></a> <span class="bp">self</span><span class="o">.</span><span class="n">delete</span><span class="p">(</span><span class="n">i</span><span class="p">)</span>
|
|
<a id="__codelineno-0-110" name="__codelineno-0-110"></a>
|
|
<a id="__codelineno-0-111" name="__codelineno-0-111"></a> <span class="k">def</span> <span class="nf">_safe_execute</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[[</span><span class="n">TinyDB</span><span class="p">],</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-></span> <span class="n">Any</span><span class="p">:</span>
|
|
<a id="__codelineno-0-112" name="__codelineno-0-112"></a> <span class="k">with</span> <span class="n">lock</span><span class="p">:</span>
|
|
<a id="__codelineno-0-113" name="__codelineno-0-113"></a> <span class="k">with</span> <span class="n">TinyDB</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">path_to_db</span><span class="p">)</span> <span class="k">as</span> <span class="n">db</span><span class="p">:</span>
|
|
<a id="__codelineno-0-114" name="__codelineno-0-114"></a> <span class="k">return</span> <span class="n">func</span><span class="p">(</span><span class="n">db</span><span class="p">)</span>
|
|
</code></pre></div></td></tr></table></div>
|
|
</details>
|
|
|
|
|
|
|
|
<div class="doc doc-children">
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<hr>
|
|
<div class="md-source-file">
|
|
<small>
|
|
|
|
Last update:
|
|
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-date">July 11, 2022</span>
|
|
|
|
|
|
</small>
|
|
</div>
|
|
|
|
|
|
|
|
</article>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</main>
|
|
|
|
<footer class="md-footer">
|
|
|
|
|
|
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
|
|
|
|
|
<a href="../how-to-guides/call-remote/" class="md-footer__link md-footer__link--prev" aria-label="Previous: How to call remote GreatAI instances" rel="prev">
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"/></svg>
|
|
</div>
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Previous
|
|
</span>
|
|
How to call remote GreatAI instances
|
|
</div>
|
|
</div>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="utilities/" class="md-footer__link md-footer__link--next" aria-label="Next: Utilities" rel="next">
|
|
<div class="md-footer__title">
|
|
<div class="md-ellipsis">
|
|
<span class="md-footer__direction">
|
|
Next
|
|
</span>
|
|
Utilities
|
|
</div>
|
|
</div>
|
|
<div class="md-footer__button md-icon">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z"/></svg>
|
|
</div>
|
|
</a>
|
|
|
|
</nav>
|
|
|
|
<div class="md-footer-meta md-typeset">
|
|
<div class="md-footer-meta__inner md-grid">
|
|
<div class="md-copyright">
|
|
|
|
<div class="md-copyright__highlight">
|
|
GNU General Public License v3
|
|
</div>
|
|
|
|
|
|
</div>
|
|
|
|
<div class="md-social">
|
|
|
|
|
|
|
|
<a href="https://schmelczer.dev" target="_blank" rel="noopener" title="about the author" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="m414.8 40.79-128 448.01c-4.9 17-22.6 26.8-39.6 22-17-4.9-26.8-22.6-22-39.6l128-447.99c4.9-16.994 22.6-26.834 39.6-21.978 17 4.855 26.8 22.568 22 39.558zm103.8 80.61 112 112c12.5 12.5 12.5 32.7 0 45.2l-112 112c-12.5 12.5-32.7 12.5-45.2 0s-12.5-32.7 0-45.2l89.3-89.4-89.3-89.4c-12.5-12.5-12.5-32.7 0-45.2s32.7-12.5 45.2 0zm-352 45.2L77.25 256l89.35 89.4c12.5 12.5 12.5 32.7 0 45.2s-32.7 12.5-45.2 0L9.372 278.6c-12.496-12.5-12.496-32.7 0-45.2l112.028-112c12.5-12.5 32.7-12.5 45.2 0s12.5 32.7 0 45.2z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="https://github.com/schmelczer/great-ai" target="_blank" rel="noopener" title="great-ai on Github" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="https://hub.docker.com/repository/docker/schmelczera/great-ai" target="_blank" rel="noopener" title="great-ai on DockerHub" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1v59.4zm0-204.3h-66.1v60.7h66.1V32zm78.2 144.8H362v59.4h66.1v-59.4zm-156.3-72.1h-66.1v60.1h66.1v-60.1zm78.1 0h-66.1v60.1h66.1v-60.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1l-13.3-8.9zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1v-59.4zm-78.1-72.1h-66.1v60.1h66.1v-60.1z"/></svg>
|
|
</a>
|
|
|
|
|
|
|
|
<a href="https://pypi.org/project/great-ai" target="_blank" rel="noopener" title="great-ai on PyPI" class="md-social__link">
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.1.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.8 200.5c-7.7-30.9-22.3-54.2-53.4-54.2h-40.1v47.4c0 36.8-31.2 67.8-66.8 67.8H172.7c-29.2 0-53.4 25-53.4 54.3v101.8c0 29 25.2 46 53.4 54.3 33.8 9.9 66.3 11.7 106.8 0 26.9-7.8 53.4-23.5 53.4-54.3v-40.7H226.2v-13.6h160.2c31.1 0 42.6-21.7 53.4-54.2 11.2-33.5 10.7-65.7 0-108.6zM286.2 404c11.1 0 20.1 9.1 20.1 20.3 0 11.3-9 20.4-20.1 20.4-11 0-20.1-9.2-20.1-20.4.1-11.3 9.1-20.3 20.1-20.3zM167.8 248.1h106.8c29.7 0 53.4-24.5 53.4-54.3V91.9c0-29-24.4-50.7-53.4-55.6-35.8-5.9-74.7-5.6-106.8.1-45.2 8-53.4 24.7-53.4 55.6v40.7h106.9v13.6h-147c-31.1 0-58.3 18.7-66.8 54.2-9.8 40.7-10.2 66.1 0 108.6 7.6 31.6 25.7 54.2 56.8 54.2H101v-48.8c0-35.3 30.5-66.4 66.8-66.4zm-6.7-142.6c-11.1 0-20.1-9.1-20.1-20.3.1-11.3 9-20.4 20.1-20.4 11 0 20.1 9.2 20.1 20.4s-9 20.3-20.1 20.3z"/></svg>
|
|
</a>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
</div>
|
|
</footer>
|
|
|
|
</div>
|
|
<div class="md-dialog" data-md-component="dialog">
|
|
<div class="md-dialog__inner md-typeset"></div>
|
|
</div>
|
|
<script id="__config" type="application/json">{"base": "..", "features": ["content.code.annotate", "content.tooltips"], "search": "../assets/javascripts/workers/search.b97dbffb.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
|
|
|
|
|
|
<script src="../assets/javascripts/bundle.6c7ad80a.min.js"></script>
|
|
|
|
|
|
</body>
|
|
</html> |