Skip to content

Commit

Permalink
Add new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
eliasdabbas committed Feb 8, 2018
1 parent d4e6f2e commit 951670d
Show file tree
Hide file tree
Showing 88 changed files with 742 additions and 13,718 deletions.
Binary file removed docs/_build/doctrees/ad_create.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/ads.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/advertools.ad_create.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/_build/doctrees/advertools.doctree
Binary file not shown.
Binary file not shown.
Binary file added docs/_build/doctrees/advertools.stopwords.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/keywords.doctree
Binary file not shown.
Binary file added docs/_build/doctrees/modules.doctree
Binary file not shown.
Binary file not shown.
Binary file removed docs/_build/doctrees/urls.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/user_reference.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/word_freq.doctree
Binary file not shown.
Binary file removed docs/_build/doctrees/word_frequency.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 71fcee46c2a454a5d72555d370b0884a
config: 37c909d62ddaf50bb0d2995a606269e1
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file removed docs/_build/html/.doctrees/environment.pickle
Binary file not shown.
Binary file removed docs/_build/html/.doctrees/index.doctree
Binary file not shown.
Empty file added docs/_build/html/.nojekyll
Empty file.
Binary file removed docs/_build/html/_images/text_ad_screen_shot.png
Binary file not shown.
Binary file removed docs/_build/html/_images/textad_diagram.png
Binary file not shown.
9 changes: 1 addition & 8 deletions docs/_build/html/_modules/advertools/ad_create.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
<div class="body" role="main">

<h1>Source code for advertools.ad_create</h1><div class="highlight"><pre>
<div class="viewcode-block" id="ad_create"><a class="viewcode-back" href="../../ads.html#advertools.ad_create.ad_create">[docs]</a><span></span><span class="k">def</span> <span class="nf">ad_create</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="n">replacements</span><span class="p">,</span> <span class="n">fallback</span><span class="p">,</span> <span class="n">max_len</span><span class="o">=</span><span class="mi">30</span><span class="p">):</span>
<div class="viewcode-block" id="ad_create"><a class="viewcode-back" href="../../advertools.ad_create.html#advertools.ad_create.ad_create">[docs]</a><span></span><span class="k">def</span> <span class="nf">ad_create</span><span class="p">(</span><span class="n">template</span><span class="p">,</span> <span class="n">replacements</span><span class="p">,</span> <span class="n">fallback</span><span class="p">,</span> <span class="n">max_len</span><span class="o">=</span><span class="mi">30</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Insert each of the replacement strings in its place within template</span>
<span class="sd"> </span>
<span class="sd"> Parameters</span>
Expand Down Expand Up @@ -91,13 +91,6 @@ <h1 class="logo"><a href="../../index.html">advertools</a></h1>


<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../keywords.html">Keywords</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ads.html">Ads</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ad_create.html">Create Text Ads From Scratch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../word_freq.html">Word Frequency</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../urls.html">URLs</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
Expand Down
9 changes: 1 addition & 8 deletions docs/_build/html/_modules/advertools/ad_from_string.html
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@

<h1>Source code for advertools.ad_from_string</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">string</span>
<div class="viewcode-block" id="ad_from_string"><a class="viewcode-back" href="../../ads.html#advertools.ad_from_string.ad_from_string">[docs]</a><span class="k">def</span> <span class="nf">ad_from_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">slots</span><span class="o">=</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span> <span class="mi">30</span><span class="p">,</span> <span class="mi">80</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">15</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">capitalize</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<div class="viewcode-block" id="ad_from_string"><a class="viewcode-back" href="../../advertools.ad_from_string.html#advertools.ad_from_string.ad_from_string">[docs]</a><span class="k">def</span> <span class="nf">ad_from_string</span><span class="p">(</span><span class="n">s</span><span class="p">,</span> <span class="n">slots</span><span class="o">=</span><span class="p">(</span><span class="mi">30</span><span class="p">,</span> <span class="mi">30</span><span class="p">,</span> <span class="mi">80</span><span class="p">,</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">15</span><span class="p">),</span> <span class="n">sep</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">capitalize</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Convert string `s` to an ad by splitting it into groups of words.</span>
<span class="sd"> Each group would have a length of at most the allowed length for that slot. </span>
<span class="sd"> </span>
Expand Down Expand Up @@ -101,13 +101,6 @@ <h1 class="logo"><a href="../../index.html">advertools</a></h1>


<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../keywords.html">Keywords</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ads.html">Ads</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ad_create.html">Create Text Ads From Scratch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../word_freq.html">Word Frequency</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../urls.html">URLs</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
Expand Down
9 changes: 1 addition & 8 deletions docs/_build/html/_modules/advertools/kw_generate.html
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ <h1>Source code for advertools.kw_generate</h1><div class="highlight"><pre>

<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>

<div class="viewcode-block" id="kw_generate"><a class="viewcode-back" href="../../keywords.html#advertools.kw_generate.kw_generate">[docs]</a><span class="k">def</span> <span class="nf">kw_generate</span><span class="p">(</span><span class="n">products</span><span class="p">,</span> <span class="n">words</span><span class="p">,</span> <span class="n">max_len</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">match_types</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;Exact&#39;</span><span class="p">,</span> <span class="s1">&#39;Phrase&#39;</span><span class="p">,</span> <span class="s1">&#39;Modified&#39;</span><span class="p">],</span>
<div class="viewcode-block" id="kw_generate"><a class="viewcode-back" href="../../advertools.kw_generate.html#advertools.kw_generate.kw_generate">[docs]</a><span class="k">def</span> <span class="nf">kw_generate</span><span class="p">(</span><span class="n">products</span><span class="p">,</span> <span class="n">words</span><span class="p">,</span> <span class="n">max_len</span><span class="o">=</span><span class="mi">3</span><span class="p">,</span> <span class="n">match_types</span><span class="o">=</span><span class="p">[</span><span class="s1">&#39;Exact&#39;</span><span class="p">,</span> <span class="s1">&#39;Phrase&#39;</span><span class="p">,</span> <span class="s1">&#39;Modified&#39;</span><span class="p">],</span>
<span class="n">campaign_name</span><span class="o">=</span><span class="s1">&#39;SEM_Campaign&#39;</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Generate a data frame of kewywords using a list of products and relevant words.</span>
<span class="sd"> </span>
Expand Down Expand Up @@ -126,13 +126,6 @@ <h1 class="logo"><a href="../../index.html">advertools</a></h1>


<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../keywords.html">Keywords</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ads.html">Ads</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ad_create.html">Create Text Ads From Scratch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../word_freq.html">Word Frequency</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../urls.html">URLs</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
Expand Down
9 changes: 1 addition & 8 deletions docs/_build/html/_modules/advertools/url_builders.html
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h1>Source code for advertools.url_builders</h1><div class="highlight"><pre>
<span></span><span class="kn">import</span> <span class="nn">urllib</span>


<div class="viewcode-block" id="url_utm_ga"><a class="viewcode-back" href="../../urls.html#advertools.url_builders.url_utm_ga">[docs]</a><span class="k">def</span> <span class="nf">url_utm_ga</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">utm_source</span><span class="p">,</span> <span class="n">utm_medium</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">utm_campaign</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<div class="viewcode-block" id="url_utm_ga"><a class="viewcode-back" href="../../advertools.url_builders.html#advertools.url_builders.url_utm_ga">[docs]</a><span class="k">def</span> <span class="nf">url_utm_ga</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">utm_source</span><span class="p">,</span> <span class="n">utm_medium</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">utm_campaign</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span>
<span class="n">utm_content</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">utm_term</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Generate a utm-encoded URL for your campaigns. </span>

Expand Down Expand Up @@ -88,13 +88,6 @@ <h1 class="logo"><a href="../../index.html">advertools</a></h1>


<h3>Navigation</h3>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../keywords.html">Keywords</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ads.html">Ads</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../ad_create.html">Create Text Ads From Scratch</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../word_freq.html">Word Frequency</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../urls.html">URLs</a></li>
</ul>

<div class="relations">
<h3>Related Topics</h3>
Expand Down
127 changes: 127 additions & 0 deletions docs/_build/html/_modules/advertools/word_frequency.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,127 @@

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>advertools.word_frequency &#8212; advertools 0.1a1 documentation</title>
<link rel="stylesheet" href="../../_static/alabaster.css" type="text/css" />
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../',
VERSION: '0.1a1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../../_static/jquery.js"></script>
<script type="text/javascript" src="../../_static/underscore.js"></script>
<script type="text/javascript" src="../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />

<link rel="stylesheet" href="../../_static/custom.css" type="text/css" />


<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

</head>
<body>


<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">

<h1>Source code for advertools.word_frequency</h1><div class="highlight"><pre>
<span></span><span class="kn">from</span> <span class="nn">collections</span> <span class="k">import</span> <span class="n">defaultdict</span>

<span class="kn">import</span> <span class="nn">advertools</span> <span class="k">as</span> <span class="nn">adv</span>
<span class="kn">import</span> <span class="nn">pandas</span> <span class="k">as</span> <span class="nn">pd</span>


<div class="viewcode-block" id="word_frequency"><a class="viewcode-back" href="../../advertools.word_frequency.html#advertools.word_frequency.word_frequency">[docs]</a><span class="k">def</span> <span class="nf">word_frequency</span><span class="p">(</span><span class="n">text_list</span><span class="p">,</span> <span class="n">num_list</span><span class="p">,</span> <span class="n">sep</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">rm_words</span><span class="o">=</span><span class="n">adv</span><span class="o">.</span><span class="n">stopwords</span><span class="p">[</span><span class="s1">&#39;english&#39;</span><span class="p">]):</span>
<span class="n">word_freq</span> <span class="o">=</span> <span class="n">defaultdict</span><span class="p">(</span><span class="k">lambda</span><span class="p">:</span> <span class="p">[</span><span class="mi">0</span><span class="p">,</span> <span class="mi">0</span><span class="p">])</span>

<span class="k">for</span> <span class="n">text</span><span class="p">,</span> <span class="n">num</span> <span class="ow">in</span> <span class="nb">zip</span><span class="p">(</span><span class="n">text_list</span><span class="p">,</span> <span class="n">num_list</span><span class="p">):</span>
<span class="k">for</span> <span class="n">word</span> <span class="ow">in</span> <span class="n">text</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">sep</span><span class="o">=</span><span class="n">sep</span><span class="p">):</span>
<span class="k">if</span> <span class="n">word</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">rm_words</span><span class="p">:</span>
<span class="k">continue</span>
<span class="n">word_freq</span><span class="p">[</span><span class="n">word</span><span class="o">.</span><span class="n">lower</span><span class="p">()][</span><span class="mi">0</span><span class="p">]</span> <span class="o">+=</span> <span class="mi">1</span>
<span class="n">word_freq</span><span class="p">[</span><span class="n">word</span><span class="o">.</span><span class="n">lower</span><span class="p">()][</span><span class="mi">1</span><span class="p">]</span> <span class="o">+=</span> <span class="n">num</span>

<span class="n">columns</span> <span class="o">=</span> <span class="p">{</span><span class="mi">0</span><span class="p">:</span> <span class="s1">&#39;abs_freq&#39;</span><span class="p">,</span> <span class="mi">1</span><span class="p">:</span> <span class="s1">&#39;wtd_freq&#39;</span><span class="p">}</span>

<span class="n">abs_wtd_df</span> <span class="o">=</span> <span class="p">(</span><span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">word_freq</span><span class="p">,</span> <span class="n">orient</span><span class="o">=</span><span class="s1">&#39;index&#39;</span><span class="p">)</span>
<span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">columns</span><span class="o">=</span><span class="n">columns</span> <span class="p">)</span>
<span class="o">.</span><span class="n">sort_values</span><span class="p">(</span><span class="s1">&#39;wtd_freq&#39;</span><span class="p">,</span> <span class="n">ascending</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
<span class="o">.</span><span class="n">assign</span><span class="p">(</span><span class="n">rel_value</span><span class="o">=</span><span class="k">lambda</span> <span class="n">df</span><span class="p">:</span> <span class="n">df</span><span class="p">[</span><span class="s1">&#39;wtd_freq&#39;</span><span class="p">]</span> <span class="o">/</span> <span class="n">df</span><span class="p">[</span><span class="s1">&#39;abs_freq&#39;</span><span class="p">])</span><span class="o">.</span><span class="n">round</span><span class="p">())</span>

<span class="n">abs_wtd_df</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">1</span><span class="p">,</span> <span class="s1">&#39;abs_perc&#39;</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="n">abs_wtd_df</span><span class="p">[</span><span class="s1">&#39;abs_freq&#39;</span><span class="p">]</span> <span class="o">/</span> <span class="n">abs_wtd_df</span><span class="p">[</span><span class="s1">&#39;abs_freq&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sum</span><span class="p">())</span>
<span class="n">abs_wtd_df</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">2</span><span class="p">,</span> <span class="s1">&#39;abs_perc_cum&#39;</span><span class="p">,</span> <span class="n">abs_wtd_df</span><span class="p">[</span><span class="s1">&#39;abs_perc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">cumsum</span><span class="p">())</span>
<span class="n">abs_wtd_df</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">4</span><span class="p">,</span> <span class="s1">&#39;wtd_freq_perc&#39;</span><span class="p">,</span> <span class="n">abs_wtd_df</span><span class="p">[</span><span class="s1">&#39;wtd_freq&#39;</span><span class="p">]</span> <span class="o">/</span> <span class="n">abs_wtd_df</span><span class="p">[</span><span class="s1">&#39;wtd_freq&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">sum</span><span class="p">())</span>
<span class="n">abs_wtd_df</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">5</span><span class="p">,</span> <span class="s1">&#39;wtd_freq_perc_cum&#39;</span><span class="p">,</span> <span class="n">abs_wtd_df</span><span class="p">[</span><span class="s1">&#39;wtd_freq_perc&#39;</span><span class="p">]</span><span class="o">.</span><span class="n">cumsum</span><span class="p">())</span>

<span class="n">abs_wtd_df</span> <span class="o">=</span> <span class="n">abs_wtd_df</span><span class="o">.</span><span class="n">reset_index</span><span class="p">()</span><span class="o">.</span><span class="n">rename</span><span class="p">(</span><span class="n">columns</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;index&#39;</span><span class="p">:</span> <span class="s1">&#39;word&#39;</span><span class="p">})</span>

<span class="k">return</span> <span class="n">abs_wtd_df</span></div>
</pre></div>

</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h1 class="logo"><a href="../../index.html">advertools</a></h1>








<h3>Navigation</h3>

<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../../index.html">Documentation overview</a><ul>
<li><a href="../index.html">Module code</a><ul>
</ul></li>
</ul></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
&copy;2018, Elias Dabbas.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.7</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>




</body>
</html>
Loading

0 comments on commit 951670d

Please sign in to comment.