Name changes from ptjs to pytorchjs

raghavmecheri · raghavmecheri · commit 00faa30e787e · 2020-11-19T17:12:02.000+05:30
diff --git a/.github/PULL_REQUEST_TEMPLATE/Bugfix.md b/.github/PULL_REQUEST_TEMPLATE/Bugfix.md
@@ -23,6 +23,6 @@ please include a screenshot showing the fix. -->
 
 <!--- If you have any questions, please reach out! We are here to help. -->
 
-- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md#guidelines)
+- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md#guidelines)
 - [ ] I have linted my code locally, following the project's code style
 - [ ] I have updated the product documentation and ensured that the changes are reflected
diff --git a/.github/PULL_REQUEST_TEMPLATE/Documentation.md b/.github/PULL_REQUEST_TEMPLATE/Documentation.md
@@ -20,4 +20,4 @@ about: Improves documentation for the API or on the docs website.
 
 <!--- If you have any questions, please reach out! We're here to help. -->
 
-- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md#guidelines)
+- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md#guidelines)
diff --git a/.github/PULL_REQUEST_TEMPLATE/Feature.md b/.github/PULL_REQUEST_TEMPLATE/Feature.md
@@ -1,6 +1,6 @@
 ---
 name: New Feature
-about: Adds a new feature to ptjs
+about: Adds a new feature to pytorchjs
 
 ---
 
@@ -43,6 +43,6 @@ comment. --->
 
 <!--- If you have any questions, please reach out! We are here to help. -->
 
-- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md#guidelines)
+- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md#guidelines)
 - [ ] I have linted my code locally, following the project's code style
 - [ ] I have tested my changes locally, and all tests pass
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,13 +1,13 @@
 # Contributing
 
-Thank you for your interest in contributing to ptjs!
+Thank you for your interest in contributing to pytorchjs!
 
-We invite you to participate in our community by adding and commenting on [issues](https://github.com/raghavmecheri/ptjs/issues) (e.g., bug reports; new feature suggestions) or contributing code enhancements through a pull request.
+We invite you to participate in our community by adding and commenting on [issues](https://github.com/raghavmecheri/pytorchjs/issues) (e.g., bug reports; new feature suggestions) or contributing code enhancements through a pull request.
 
-If you have any general questions about contributing to ptjs, please feel free to email [Raghav](raghav.mecheri@columbia.edu), or just open an issue on [Github](https://github.com/raghavmecheri/ptjs/issues/new).
+If you have any general questions about contributing to pytorchjs, please feel free to email [Raghav](raghav.mecheri@columbia.edu), or just open an issue on [Github](https://github.com/raghavmecheri/pytorchjs/issues/new).
 ## Guidelines
 
-When submitting PRs to ptjs, please respect the following general
+When submitting PRs to pytorchjs, please respect the following general
 coding guidelines:
 
 * All PRs should be accompanied by an appropriate label as per [lerna-changelog](https://github.com/lerna/lerna-changelog), and reference any issue they resolve.
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
 <div align="center">
 
-<img src="https://raw.githubusercontent.com/raghavmecheri/ptjs/master/assets/img/ptjs.png" width="300px">
+<img src="https://raw.githubusercontent.com/raghavmecheri/pytorchjs/master/assets/img/ptjs.png" width="300px">
 
 
 **Torch and TorchVision, for your Node servers.
diff --git a/examples/Exporting/Exporting.md b/examples/Exporting/Exporting.md
@@ -1,5 +1,5 @@
-# Exporting your PyTorch model for use with ptjs
-ptjs currently only supports models that are in TorchScript, which is an intermediate representation of a PYTorch model that can be run in other high performance environments like C++ and (thanks to this library!) JavaScript.<br>
+# Exporting your PyTorch model for use with pytorchjs
+pytorchjs currently only supports models that are in TorchScript, which is an intermediate representation of a PYTorch model that can be run in other high performance environments like C++ and (thanks to this library!) JavaScript.<br>
 However, any PyTorch model can be saved as a TorchScript module. An example of the same may be found below.
 ```python
 import torch
diff --git a/examples/Usage/Basic.md b/examples/Usage/Basic.md
@@ -1,7 +1,7 @@
-# Using ptjs to run your torchscript models in Node
+# Using pytorchjs to run your torchscript models in Node
 
 ## Background
-This example assumes that you have a pre-trained torch model, that has been exported to [torchscript](https://pytorch.org/tutorials/beginner/Intro_to_TorchScript_tutorial.html), as well as an image dataset conforming to the structure that the ptjs DatasetFolder class expects. The structure may also be found below, for reference, and a sample script to export a torch model to torchscript can be found [here](../Exporting/Exporting.md)
+This example assumes that you have a pre-trained torch model, that has been exported to [torchscript](https://pytorch.org/tutorials/beginner/Intro_to_TorchScript_tutorial.html), as well as an image dataset conforming to the structure that the pytorchjs DatasetFolder class expects. The structure may also be found below, for reference, and a sample script to export a torch model to torchscript can be found [here](../Exporting/Exporting.md)
 
 ## Required File Structure
 ```
diff --git a/examples/Usage/Transforms.md b/examples/Usage/Transforms.md
@@ -1,7 +1,7 @@
-# Using a custom ptjs transform in your workflow
+# Using a custom pytorchjs transform in your workflow
 
 ## Background
-This example assumes that you have a pre-trained torch model, that has been exported to [torchscript](https://pytorch.org/tutorials/beginner/Intro_to_TorchScript_tutorial.html), as well as an image dataset conforming to the structure that the ptjs DatasetFolder class expects. The structure may also be found below, for reference, and a sample script to export a torch model to torchscript can be found [here](../Exporting/Exporting.md)
+This example assumes that you have a pre-trained torch model, that has been exported to [torchscript](https://pytorch.org/tutorials/beginner/Intro_to_TorchScript_tutorial.html), as well as an image dataset conforming to the structure that the pytorchjs DatasetFolder class expects. The structure may also be found below, for reference, and a sample script to export a torch model to torchscript can be found [here](../Exporting/Exporting.md)
 
 ## Required File Structure
 ```
diff --git a/package.json b/package.json
@@ -16,6 +16,7 @@
     "pytorch",
     "torch",
     "torchvision",
+    "pytorchjs",
     "ptjs"
   ],
   "dependencies": {
diff --git a/src/index.js b/src/index.js
@@ -1,20 +1,20 @@
 /**
- * A module representing ptjs and its components
- * @exports ptjs
+ * A module representing pytorchjs and its components
+ * @exports pytorchjs
  * @author Raghav Mecheri
  */
 import torch from "./torch";
 import torchvision from "./torchvision";
 
 /**
- * @summary A module representing ptjs and its components
- * @property {Object} torch The ptjs torch module
- * @property {Object} torchvision The ptjs torchvision module
+ * @summary A module representing pytorchjs and its components
+ * @property {Object} torch The pytorchjs torch module
+ * @property {Object} torchvision The pytorchjs torchvision module
  */
 
-const ptjs = {
+const pytorchjs = {
   torch,
   torchvision,
 };
 
-module.exports = ptjs;
+module.exports = pytorchjs;
diff --git a/src/torch.js b/src/torch.js
@@ -1,7 +1,7 @@
 /**
  * PyTorch and it's functions, but in Javascript :)
- * @module ptjs/torch
- * @memberof ptjs
+ * @module pytorchjs/torch
+ * @memberof pytorchjs
  */
 import { Dataset, DataLoader } from "./torch/utils/data";
 import { load } from "./torch/load";
@@ -11,19 +11,19 @@ import { Model } from "./torch/model";
  * A collection of modules to minic torch functionality
  * @property {Object} utils A collection of torch utilities
  * @property {Function} load Utility to load a torchscript model
- * @property {class} Model A class representing a ptjs model
+ * @property {class} Model A class representing a pytorchjs model
  */
 const torch = {
   /**
    * A collection of torch utils
-   * @module ptjs/torch/utils
-   * @memberof ptjs/torch
+   * @module pytorchjs/torch/utils
+   * @memberof pytorchjs/torch
    * @property {Object} utils.data A collection of data manipulation utilities
    */
   utils: {
     /**
-     * @module ptjs/torch/utils/data
-     * @memberof ptjs/torch/utils
+     * @module pytorchjs/torch/utils/data
+     * @memberof pytorchjs/torch/utils
      * @property {Object} utils.data.Dataset An extendable base Dataset class
      * @property {Object} utils.data.DataLoader A class that allows for in-memory loading of a Dataset for inference
      */
diff --git a/src/torch/load.js b/src/torch/load.js
@@ -8,7 +8,7 @@ import { Model } from "./model";
 /**
  * Given a model path, load a model from the torch class
  * @param {*} path - Path to .pt model
- * @returns {Model} - A loaded ptjs model
+ * @returns {Model} - A loaded pytorchjs model
  */
 export const load = (path) => {
   return new Model(path);
diff --git a/src/torch/model.js b/src/torch/model.js
@@ -3,7 +3,7 @@ import { DataLoader } from "./utils/data";
 const torch = require("torch-js");
 
 /**
- * Create a callable ptjs model object
+ * Create a callable pytorchjs model object
  * @extends Function
  */
 export class Model extends Function {
diff --git a/src/torch/utils/data.js b/src/torch/utils/data.js
@@ -42,7 +42,7 @@ class _SingleProcessDataloaderIter extends _BaseDataLoaderIter {
 
 /**
  * A barebones representation of a Dataset
- * @class module:ptjs/torch/utils/data.Dataset
+ * @class module:pytorchjs/torch/utils/data.Dataset
  */
 export class Dataset {
   /**
@@ -56,7 +56,7 @@ export class Dataset {
 }
 
 /**
- * @class module:ptjs/torch/utils/data.DataLoader
+ * @class module:pytorchjs/torch/utils/data.DataLoader
  * Load your datasets at a given rate in order to perform effective inference
  */
 export class DataLoader {
diff --git a/src/torchvision.js b/src/torchvision.js
@@ -1,7 +1,7 @@
 /**
  * A module representing torchvision's functionality
- * @module ptjs/torchvision
- * @memberof ptjs
+ * @module pytorchjs/torchvision
+ * @memberof pytorchjs
  */
 
 import {
@@ -24,8 +24,8 @@ import { VisionDataset } from "./torchvision/datasets/VisionDataset";
 const torchvision = {
   /**
    * A collection of classes to enable torchvision transforms
-   * @module ptjs/torchvision/transforms
-   * @memberof ptjs/torchvision
+   * @module pytorchjs/torchvision/transforms
+   * @memberof pytorchjs/torchvision
    * @property {Object} InvertAxes Transform that enables inverting image axes
    * @property {Object} Resize Transform that enables resizing images
    * @property {Object} Grayscale Transform that enables converting images to Greyscale
@@ -42,8 +42,8 @@ const torchvision = {
     DefaultTransform,
   },
   /**
-   * @module ptjs/torchvision/datasets
-   * @memberof ptjs/torchvision
+   * @module pytorchjs/torchvision/datasets
+   * @memberof pytorchjs/torchvision
    * @property {Object} ImageFolder Functional class representation of an image dataset
    * @property {Object} DatasetFolder Extendable class representation of a DatasetFolder
    * @property {Object} VisionDataset Extendable base class for a VisionDataset
diff --git a/src/torchvision/transforms/transforms.js b/src/torchvision/transforms/transforms.js
@@ -110,7 +110,7 @@ export class Resize extends Function {
 }
 
 /**
- * Compose a sequence of ptjs transforms
+ * Compose a sequence of pytorchjs transforms
  * @extends Function
  */
 export class Compose extends Function {

Original file line number	Diff line number	Diff line change
`@@ -20,4 +20,4 @@ about: Improves documentation for the API or on the docs website.`
`20`	`20`
`21`	`21`	`<!--- If you have any questions, please reach out! We're here to help. -->`
`22`	`22`
`23`		-- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/ptjs/blob/master/CONTRIBUTING.md#guidelines)
	`23`	+- [ ] I have read the [`CONTRIBUTING.md`](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md) and followed its [Guidelines](https://github.com/raghavmecheri/pytorchjs/blob/master/CONTRIBUTING.md#guidelines)