From aa22bb29b27f0b981ed16b496c94d3dba9c25c87 Mon Sep 17 00:00:00 2001
From: pomonam <pomonam15@gmail.com>
Date: Mon, 1 Oct 2018 00:23:34 -0400
Subject: [PATCH] Update README

---
 .idea/workspace.xml                           | 195 ++++++++----------
 README.md                                     |  28 +--
 ...oling_Methods_for_Video_Classification.pdf | Bin
 3 files changed, 97 insertions(+), 126 deletions(-)
 rename Learnable_Pooling_Methods_for_Video_Classification.pdf => paper/Learnable_Pooling_Methods_for_Video_Classification.pdf (100%)

diff --git a/.idea/workspace.xml b/.idea/workspace.xml
index 0b0180a..01afa4b 100644
--- a/.idea/workspace.xml
+++ b/.idea/workspace.xml
@@ -2,91 +2,8 @@
 <project version="4">
   <component name="ChangeListManager">
     <list default="true" id="370d4654-9bf0-4423-b50b-4b5357b1a30d" name="Default Changelist" comment="">
-      <change beforePath="$PROJECT_DIR$/.gitignore" beforeDir="false" afterPath="$PROJECT_DIR$/.gitignore" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/aggregation_modules.py" beforeDir="false" afterPath="$PROJECT_DIR$/aggregation_modules.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/attention_modules.py" beforeDir="false" afterPath="$PROJECT_DIR$/attention_modules.py" afterDir="false" />
-      <change beforePath="$PROJECT_DIR$/cloudml_config/cloudml-4gpu.yaml" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/cloudml_config/cloudml-gpu-distributed.yaml" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/cloudml_config/cloudml-gpu-inference.yaml" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/cloudml_config/cloudml-gpu.yaml" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/cloudml_config/cloudml-tpu.yaml" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV10-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV11-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV11-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV11-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV11-4.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV11-5.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV11-6.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV12-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV13-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV13-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV13-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV13-4.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV13-6.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV13-7.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV14-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV3-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV3-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV3-4.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV4-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV5-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV5-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV5.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV6-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV6-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV7-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV7-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV8-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV9-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV9-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV9-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV9-4.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyFishV9-5.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyModelV1-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyModelV11-5.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyTestV1-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/CrazyTestV1-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/FishModelV1-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/FishModelV2-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/FishModelV3-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/FishModelV4-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV1-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV1-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV1-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV2-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV2-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV3-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV3-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV4-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV4-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JbTransformerV5-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV1-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV1-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV1-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV1-4.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV2-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV2-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV2-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV3-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV3-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV4-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV5-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV6-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV6-2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/JuhanTestModelV6-3.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/TransformerV1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/TriangulationCnnClusterModel-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/jbTransformerV4-1.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/template.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/willow-69.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/history/willow.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/cnn_check.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/non_share_cnn_investigate.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/shift_attention.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/shift_attention2.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/temb_check.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/temb_finite_difference.py" beforeDir="false" />
-      <change beforePath="$PROJECT_DIR$/investigation/temp.txt" beforeDir="false" />
+      <change beforePath="$PROJECT_DIR$/Learnable_Pooling_Methods_for_Video_Classification.pdf" beforeDir="false" afterPath="$PROJECT_DIR$/paper/Learnable_Pooling_Methods_for_Video_Classification.pdf" afterDir="false" />
+      <change beforePath="$PROJECT_DIR$/README.md" beforeDir="false" afterPath="$PROJECT_DIR$/README.md" afterDir="false" />
     </list>
     <option name="EXCLUDED_CONVERTED_TO_IGNORED" value="true" />
     <option name="SHOW_DIALOG" value="false" />
@@ -127,14 +44,42 @@
         </counts>
       </usages-collector>
     </session>
+    <session id="244045650">
+      <usages-collector id="statistics.lifecycle.project">
+        <counts>
+          <entry key="project.open.time.1" value="1" />
+          <entry key="project.opened" value="1" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.extensions.open">
+        <counts>
+          <entry key="md" value="1" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.types.open">
+        <counts>
+          <entry key="Markdown" value="1" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.extensions.edit">
+        <counts>
+          <entry key="md" value="435" />
+        </counts>
+      </usages-collector>
+      <usages-collector id="statistics.file.types.edit">
+        <counts>
+          <entry key="Markdown" value="435" />
+        </counts>
+      </usages-collector>
+    </session>
   </component>
   <component name="FileEditorManager">
-    <leaf>
+    <leaf SIDE_TABS_SIZE_LIMIT_KEY="300">
       <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/.gitignore">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="-1208">
-              <caret line="22" column="11" lean-forward="true" selection-start-line="22" selection-start-column="11" selection-end-line="22" selection-end-column="11" />
+            <state relative-caret-position="330">
+              <caret line="22" column="11" selection-start-line="22" selection-start-column="11" selection-end-line="22" selection-end-column="11" />
             </state>
           </provider>
         </entry>
@@ -142,7 +87,7 @@
       <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/aggregation_modules.py">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="-1260">
+            <state relative-caret-position="1095">
               <caret line="74" column="8" selection-start-line="74" selection-start-column="8" selection-end-line="74" selection-end-column="8" />
               <folding>
                 <element signature="e#659#682#0" expanded="true" />
@@ -151,10 +96,10 @@
           </provider>
         </entry>
       </file>
-      <file pinned="false" current-in-tab="true">
+      <file pinned="false" current-in-tab="false">
         <entry file="file://$PROJECT_DIR$/attention_modules.py">
           <provider selected="true" editor-type-id="text-editor">
-            <state relative-caret-position="-3060">
+            <state relative-caret-position="15">
               <caret line="126" column="99" selection-start-line="126" selection-start-column="99" selection-end-line="126" selection-end-column="99" />
               <folding>
                 <element signature="e#600#636#0" expanded="true" />
@@ -163,6 +108,18 @@
           </provider>
         </entry>
       </file>
+      <file pinned="false" current-in-tab="true">
+        <entry file="file://$PROJECT_DIR$/README.md">
+          <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
+            <state split_layout="SPLIT">
+              <first_editor relative-caret-position="118">
+                <caret line="10" column="17" selection-start-line="10" selection-start-column="17" selection-end-line="10" selection-end-column="17" />
+              </first_editor>
+              <second_editor />
+            </state>
+          </provider>
+        </entry>
+      </file>
     </leaf>
   </component>
   <component name="Git.Settings">
@@ -175,6 +132,7 @@
         <option value="$PROJECT_DIR$/history/CrazyFishV4-1.py" />
         <option value="$PROJECT_DIR$/aggregation_modules.py" />
         <option value="$PROJECT_DIR$/attention_modules.py" />
+        <option value="$PROJECT_DIR$/README.md" />
       </list>
     </option>
   </component>
@@ -191,23 +149,33 @@
       <foldersAlwaysOnTop value="true" />
     </navigator>
     <panes>
-      <pane id="Scope" />
       <pane id="ProjectPane">
         <subPane>
           <expand>
             <path>
-              <item name="LearnablePoolingMethodsForVideoClassification" type="b2602c69:ProjectViewProjectNode" />
-              <item name="LearnablePoolingMethodsForVideoClassification" type="462c0819:PsiDirectoryNode" />
+              <item name="LearnablePoolingMethods" type="b2602c69:ProjectViewProjectNode" />
+              <item name="LearnablePoolingMethods" type="462c0819:PsiDirectoryNode" />
+            </path>
+            <path>
+              <item name="LearnablePoolingMethods" type="b2602c69:ProjectViewProjectNode" />
+              <item name="LearnablePoolingMethods" type="462c0819:PsiDirectoryNode" />
+              <item name="paper" type="462c0819:PsiDirectoryNode" />
             </path>
           </expand>
           <select />
         </subPane>
       </pane>
+      <pane id="Scope" />
     </panes>
   </component>
   <component name="PropertiesComponent">
     <property name="last_opened_file_path" value="$PROJECT_DIR$" />
   </component>
+  <component name="RecentsManager">
+    <key name="MoveFile.RECENT_KEYS">
+      <recent name="$PROJECT_DIR$/paper" />
+    </key>
+  </component>
   <component name="RunDashboard">
     <option name="ruleStates">
       <list>
@@ -235,15 +203,10 @@
   </component>
   <component name="ToolWindowManager">
     <frame x="0" y="23" width="1280" height="709" extended-state="0" />
-    <editor active="true" />
     <layout>
-      <window_info id="Favorites" side_tool="true" />
-      <window_info active="true" content_ui="combo" id="Project" order="0" visible="true" weight="0.2494043" />
+      <window_info active="true" content_ui="combo" id="Project" order="0" visible="true" weight="0.1302621" />
       <window_info id="Structure" order="1" side_tool="true" weight="0.25" />
-      <window_info anchor="bottom" id="Version Control" show_stripe_button="false" />
-      <window_info anchor="bottom" id="Python Console" />
-      <window_info anchor="bottom" id="Terminal" />
-      <window_info anchor="bottom" id="Event Log" side_tool="true" />
+      <window_info id="Favorites" order="2" side_tool="true" />
       <window_info anchor="bottom" id="Message" order="0" />
       <window_info anchor="bottom" id="Find" order="1" />
       <window_info anchor="bottom" id="Run" order="2" />
@@ -251,6 +214,10 @@
       <window_info anchor="bottom" id="Cvs" order="4" weight="0.25" />
       <window_info anchor="bottom" id="Inspection" order="5" weight="0.4" />
       <window_info anchor="bottom" id="TODO" order="6" />
+      <window_info anchor="bottom" id="Version Control" order="7" show_stripe_button="false" />
+      <window_info anchor="bottom" id="Terminal" order="8" />
+      <window_info anchor="bottom" id="Event Log" order="9" side_tool="true" />
+      <window_info anchor="bottom" id="Python Console" order="10" />
       <window_info anchor="right" id="Commander" internal_type="SLIDING" order="0" type="SLIDING" weight="0.4" />
       <window_info anchor="right" id="Ant Build" order="1" weight="0.25" />
       <window_info anchor="right" content_ui="combo" id="Hierarchy" order="2" weight="0.25" />
@@ -276,23 +243,17 @@
     <entry file="file://$PROJECT_DIR$/scripts/generate_gcloud_train_valid.py">
       <provider selected="true" editor-type-id="text-editor" />
     </entry>
-    <entry file="file://$PROJECT_DIR$/history/CrazyFishV4-1.py">
-      <provider selected="true" editor-type-id="text-editor">
-        <state>
-          <caret column="2" selection-start-column="2" selection-end-column="2" />
-        </state>
-      </provider>
-    </entry>
+    <entry file="file://$PROJECT_DIR$/history/CrazyFishV4-1.py" />
     <entry file="file://$PROJECT_DIR$/.gitignore">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="-1208">
-          <caret line="22" column="11" lean-forward="true" selection-start-line="22" selection-start-column="11" selection-end-line="22" selection-end-column="11" />
+        <state relative-caret-position="330">
+          <caret line="22" column="11" selection-start-line="22" selection-start-column="11" selection-end-line="22" selection-end-column="11" />
         </state>
       </provider>
     </entry>
     <entry file="file://$PROJECT_DIR$/aggregation_modules.py">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="-1260">
+        <state relative-caret-position="1095">
           <caret line="74" column="8" selection-start-line="74" selection-start-column="8" selection-end-line="74" selection-end-column="8" />
           <folding>
             <element signature="e#659#682#0" expanded="true" />
@@ -302,7 +263,7 @@
     </entry>
     <entry file="file://$PROJECT_DIR$/attention_modules.py">
       <provider selected="true" editor-type-id="text-editor">
-        <state relative-caret-position="-3060">
+        <state relative-caret-position="15">
           <caret line="126" column="99" selection-start-line="126" selection-start-column="99" selection-end-line="126" selection-end-column="99" />
           <folding>
             <element signature="e#600#636#0" expanded="true" />
@@ -310,5 +271,15 @@
         </state>
       </provider>
     </entry>
+    <entry file="file://$PROJECT_DIR$/README.md">
+      <provider selected="true" editor-type-id="split-provider[text-editor;markdown-preview-editor]">
+        <state split_layout="SPLIT">
+          <first_editor relative-caret-position="118">
+            <caret line="10" column="17" selection-start-line="10" selection-start-column="17" selection-end-line="10" selection-end-column="17" />
+          </first_editor>
+          <second_editor />
+        </state>
+      </provider>
+    </entry>
   </component>
 </project>
\ No newline at end of file
diff --git a/README.md b/README.md
index 9c7948c..cdddf45 100644
--- a/README.md
+++ b/README.md
@@ -1,33 +1,33 @@
 # Learnable Pooling Methods for Video Classification
 The repository is based on the starter code provided by Google AI. It contains a code for training and evaluating models for [YouTube-8M](https://research.google.com/youtube8m/) dataset. The detailed table of contents and descriptions can be found at [original repository](https://github.com/google/youtube-8m).
 
-Our approach was accepted in [ECCV - The 2nd Workshop on YouTube-8M Large-Scale Video Understanding](https://research.google.com/youtube8m/workshop2018/index.html). The presentation is accessable in official ECCV Workshop page.
+The repository contains models from team "Deep Topology". Our approach was accepted in [ECCV - The 2nd Workshop on YouTube-8M Large-Scale Video Understanding](https://research.google.com/youtube8m/workshop2018/index.html). The presentation is accessible in ECCV Workshop page.
 
-At the moment, we are refactoring our code for reusuability.
-
-# Changes
-- **1.00** (31 August 2018)
-    - Initial public release
-- **2.00** (30 September 2018)
-    - Code cleaning
-    - Model usage
+Presentation: TBA \
+Paper: [Link](paper/Learnable_Pooling_Methods_for_Video_Classification.pdf)
     
 # Usage
-In frame_level_models.py, Prototype 1, 2 and 3 refer to Sections 3.1, 3.2 and 3.3 in our paper. Detailed instructions for performing model verification and inference can be found in the [YT8M repository](https://github.com/google/youtube-8m). Below we provide example usage of training these models:
-
-### Prototype 1
+In [frame_level_models.py](frame_level_models.py), prototype 1, 2 and 3 refer to sections 3.1, 3.2 and 3.2 in the paper. The detailed instructions instructions to train and evaluate the model can be found at [YT8M repository](https://github.com/google/youtube-8m). The following is the example training command to reproduce the result.
+### Prototype 1 (Attention Enhanced NetVLAD)
 ```
 python train.py --train_data_pattern="<path to train .tfrecord>" --model=NetVladV1 --train_dir="<path for model checkpoints>" --frame_features=True --feature_names="rgb,audio" --feature_sizes="1024,128" --batch_size=80 --base_learning_rate=0.0002 --netvlad_cluster_size=256 --netvlad_hidden_size=512 --iterations=256 --learning_rate_decay=0.85
 ```
-### Prototype 2
+### Prototype 2 (NetVLAD with Attention Based Cluster Similarities)
 ```
 python train.py --train_data_pattern="<path to train .tfrecord>" --model=NetVladV2 --train_dir="<path for model checkpoints>" --frame_features=True --feature_names="rgb,audio" --feature_sizes="1024,128" --batch_size=80 --base_learning_rate=0.0002 --netvlad_cluster_size=256 --netvlad_hidden_size=512 --iterations=256 --learning_rate_decay=0.85
 ```
-### Prototype 3
+### Prototype 3 (Regularized Function Approximation Approach)
 ```
 TBD
 ```
 
+# Changes
+- **1.00** (31 August 2018)
+    - Initial public release
+- **2.00** (30 September 2018)
+    - Code cleaning
+    - Model usage
+
 # Contributors (Alphabetical Order)
 - [Ruijian An](https://github.com/RuijianSZ)
 - [Juhan Bae](https://github.com/pomonam)
diff --git a/Learnable_Pooling_Methods_for_Video_Classification.pdf b/paper/Learnable_Pooling_Methods_for_Video_Classification.pdf
similarity index 100%
rename from Learnable_Pooling_Methods_for_Video_Classification.pdf
rename to paper/Learnable_Pooling_Methods_for_Video_Classification.pdf