зеркало из
https://github.com/ssciwr/AMMICO.git
synced 2025-10-29 21:16:06 +02:00
198 строки
17 KiB
HTML
198 строки
17 KiB
HTML
|
|
|
|
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" data-content_root="./">
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>AMMICO package modules — AMMICO 0.2.2 documentation</title>
|
|
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
|
|
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
|
|
|
|
|
|
<script src="_static/jquery.js?v=5d32c60e"></script>
|
|
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
|
|
<script src="_static/documentation_options.js?v=000c92bf"></script>
|
|
<script src="_static/doctools.js?v=9a2dae69"></script>
|
|
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
|
|
<script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="text module" href="ammico.html" />
|
|
<link rel="prev" title="Crop posts module" href="notebooks/Example%20cropposts.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
|
|
|
|
|
|
<a href="index.html" class="icon icon-home">
|
|
AMMICO
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
|
|
<ul class="current">
|
|
<li class="toctree-l1"><a class="reference internal" href="readme_link.html">AMMICO - AI-based Media and Misinformation Content Analysis Tool</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="faq_link.html">FAQ</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="create_API_key_link.html">Instructions how to generate and enable a google Cloud Vision API key</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notebooks/DemoNotebook_ammico.html">AMMICO Demonstration Notebook</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notebooks/DemoNotebook_ammico.html#Step-0:-Create-and-set-a-Google-Cloud-Vision-Key">Step 0: Create and set a Google Cloud Vision Key</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notebooks/DemoNotebook_ammico.html#Step-1:-Read-your-data-into-AMMICO">Step 1: Read your data into AMMICO</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notebooks/DemoNotebook_ammico.html#The-detector-modules">The detector modules</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="notebooks/Example%20cropposts.html">Crop posts module</a></li>
|
|
<li class="toctree-l1 current"><a class="current reference internal" href="#">AMMICO package modules</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html">text module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#module-summary">summary module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#multimodal-search-module">multimodal search module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#module-faces">faces module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#module-colors">color_analysis module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#module-cropposts">cropposts module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#utils-module">utils module</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#display-module">display module</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="license_link.html">License</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="index.html">AMMICO</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
|
|
<li class="breadcrumb-item active">AMMICO package modules</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="https://github.com/ssciwr/AMMICO/blob/main/docs/source/modules.rst" class="fa fa-github"> Edit on GitHub</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="ammico-package-modules">
|
|
<h1>AMMICO package modules<a class="headerlink" href="#ammico-package-modules" title="Link to this heading"></a></h1>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html">text module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#module-summary">summary module</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#summary.SummaryDetector"><code class="docutils literal notranslate"><span class="pre">SummaryDetector</span></code></a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.all_allowed_model_types"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.all_allowed_model_types</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.allowed_analysis_types"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.allowed_analysis_types</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.allowed_model_types"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.allowed_model_types</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.allowed_new_model_types"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.allowed_new_model_types</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.analyse_image"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.analyse_image()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.analyse_questions"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.analyse_questions()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.analyse_summary"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.analyse_summary()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.check_model"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.check_model()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_base"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_base()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_base_blip2_opt_caption_coco_opt67b"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_base_blip2_opt_caption_coco_opt67b()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_base_blip2_opt_pretrain_opt67b"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_base_blip2_opt_pretrain_opt67b()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_blip2_opt_caption_coco_opt27b"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_blip2_opt_caption_coco_opt27b()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_blip2_opt_pretrain_opt27b"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_blip2_opt_pretrain_opt27b()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_blip2_t5_caption_coco_flant5xl"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_blip2_t5_caption_coco_flant5xl()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_blip2_t5_pretrain_flant5xl"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_blip2_t5_pretrain_flant5xl()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_blip2_t5_pretrain_flant5xxl"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_blip2_t5_pretrain_flant5xxl()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_model_large"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_model_large()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_new_model"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_new_model()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#summary.SummaryDetector.load_vqa_model"><code class="docutils literal notranslate"><span class="pre">SummaryDetector.load_vqa_model()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#multimodal-search-module">multimodal search module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#module-faces">faces module</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#faces.EmotionDetector"><code class="docutils literal notranslate"><span class="pre">EmotionDetector</span></code></a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#faces.EmotionDetector.analyse_image"><code class="docutils literal notranslate"><span class="pre">EmotionDetector.analyse_image()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#faces.EmotionDetector.analyze_single_face"><code class="docutils literal notranslate"><span class="pre">EmotionDetector.analyze_single_face()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#faces.EmotionDetector.clean_subdict"><code class="docutils literal notranslate"><span class="pre">EmotionDetector.clean_subdict()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#faces.EmotionDetector.facial_expression_analysis"><code class="docutils literal notranslate"><span class="pre">EmotionDetector.facial_expression_analysis()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#faces.EmotionDetector.set_keys"><code class="docutils literal notranslate"><span class="pre">EmotionDetector.set_keys()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#faces.EmotionDetector.wears_mask"><code class="docutils literal notranslate"><span class="pre">EmotionDetector.wears_mask()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#faces.deepface_symlink_processor"><code class="docutils literal notranslate"><span class="pre">deepface_symlink_processor()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#faces.ethical_disclosure"><code class="docutils literal notranslate"><span class="pre">ethical_disclosure()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#module-colors">color_analysis module</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#colors.ColorDetector"><code class="docutils literal notranslate"><span class="pre">ColorDetector</span></code></a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#colors.ColorDetector.analyse_image"><code class="docutils literal notranslate"><span class="pre">ColorDetector.analyse_image()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#colors.ColorDetector.rgb2name"><code class="docutils literal notranslate"><span class="pre">ColorDetector.rgb2name()</span></code></a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="ammico.html#colors.ColorDetector.set_keys"><code class="docutils literal notranslate"><span class="pre">ColorDetector.set_keys()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#module-cropposts">cropposts module</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.compute_crop_corner"><code class="docutils literal notranslate"><span class="pre">compute_crop_corner()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.crop_image_from_post"><code class="docutils literal notranslate"><span class="pre">crop_image_from_post()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.crop_media_posts"><code class="docutils literal notranslate"><span class="pre">crop_media_posts()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.crop_posts_from_refs"><code class="docutils literal notranslate"><span class="pre">crop_posts_from_refs()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.crop_posts_image"><code class="docutils literal notranslate"><span class="pre">crop_posts_image()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.draw_matches"><code class="docutils literal notranslate"><span class="pre">draw_matches()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.kp_from_matches"><code class="docutils literal notranslate"><span class="pre">kp_from_matches()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.matching_points"><code class="docutils literal notranslate"><span class="pre">matching_points()</span></code></a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="ammico.html#cropposts.paste_image_and_comment"><code class="docutils literal notranslate"><span class="pre">paste_image_and_comment()</span></code></a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#utils-module">utils module</a></li>
|
|
<li class="toctree-l1"><a class="reference internal" href="ammico.html#display-module">display module</a></li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="notebooks/Example%20cropposts.html" class="btn btn-neutral float-left" title="Crop posts module" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
|
|
<a href="ammico.html" class="btn btn-neutral float-right" title="text module" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2022, Scientific Software Center, Heidelberg University.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |