Update package name

Created first release on PyPi

pytorch_goturn/Goturn.py → GoTurn/Model.py

@@ -3,9 +3,9 @@
 from torch import nn
 
 
-class Goturn(nn.Module):
+class Model(nn.Module):
     def __init__(self, pretrained=None):
-        super(Goturn, self).__init__()
+        super(Model, self).__init__()
         self.features_previous = nn.Sequential()
         self.features_previous.add_module('conv11', nn.Conv2d(in_channels=3, out_channels=96, kernel_size=11, stride=4))
         self.features_previous.add_module('relu11', nn.ReLU())

GoTurn/__init__.py

@@ -0,0 +1 @@
+from .Goturn import Model

README.rst

@@ -1,25 +1,25 @@
 ==============
-pytorch_goturn
+goturn_pytorch
 ==============
 A PyTorch port of GOTURN tracker
 ________________________________
 
 **Installation:**
 
   1. Download this repository
-  2. navigate to the root of the repository and run :code:`pip install .`
+  2. navigate to the root of the repository and run :code:`pip install goturn_pytorch`
 
 **Usage:**
 
 To create the model,
-  ``from pytorch_goturn import Goturn``
+  ``from GoTurn import Model``
 
-  ``goturn = Goturn()``
+  ``goturn = Model()``
 
 To create a pretrained model, 
-  ``from pytorch_goturn import Goturn``
+  ``from GoTurn import Model``
 
-  ``goturn = Goturn(pretrained="path_to_weights.pkl")``
+  ``goturn = Model(pretrained="path_to_weights.pkl")``
 
 The :code:`weights.pkl` file is located at the root of the repository.
 

setup.py

@@ -1,18 +1,25 @@
 from setuptools import setup
+from os import path
 
-setup(name='pytorch-goturn',
-      version='1.0',
+DIR = path.dirname(path.abspath(__file__))
+
+with open(path.join(DIR, 'README.rst')) as f:
+      README = f.read()
+
+setup(name='goturn_pytorch',
+      packages=['GoTurn'],
       description='A PyTorch port of GOTURN tracker',
+      long_description=README,
+      install_requires=['torch'],
+      version='1.0',
       url='https://github.com/aakaashjois/PyTorch-GOTURN',
       classifiers=[
             'Development Status :: 5 - Production/Stable',
             'License :: OSI Approved :: MIT License',
             'Programming Language :: Python :: 3.7',
             'Topic :: Scientific/Engineering :: Artificial Intelligence',
       ],
+      keywords=['machine-learning', 'pytorch', 'deep-learning'],
       author='Aakaash Jois',
       author_email='aakaashjois@gmail.com',
-      license='MIT',
-      packages=['pytorch_goturn'],
-      install_requires=['torch'],
-      zip_safe=False)
+      license='MIT')