Merge pull request #684 from liyier90/docs-aisingapore-migration

Docs: aisingapore migration

.github/workflows/assign_issue_to_project.yml

@@ -12,8 +12,8 @@ jobs:
 
     name: Assign to One Project
     steps:
-    - name: Assign NEW issue to One Project
-      uses: srggrs/[email protected]
-      if: github.event.action == 'opened'
-      with:
-        project: 'https://github.com/orgs/aimakerspace/projects/1'
+      - name: Assign NEW issue to One Project
+        uses: srggrs/[email protected]
+        if: github.event.action == 'opened'
+        with:
+          project: "https://github.com/orgs/aisingapore/projects/1"

CONTRIBUTING.md

@@ -24,7 +24,7 @@ We welcome all types of contributions to grow and make PeekingDuck better.
 
 ### Report a Bug
 
-Before you report a new bug, do check our [issues tracker](https://github.com/aimakerspace/PeekingDuck/issues) to ensure that the problem hasn't already been reported. If it has, just leave a comment on the existing issue, instead of creating a new issue. If it has not been reported, file a new issue and tag it as a bug. In the issue, please provide a short description of the bug and the steps required to replicate it.
+Before you report a new bug, do check our [issues tracker](https://github.com/aisingapore/PeekingDuck/issues) to ensure that the problem hasn't already been reported. If it has, just leave a comment on the existing issue, instead of creating a new issue. If it has not been reported, file a new issue and tag it as a bug. In the issue, please provide a short description of the bug and the steps required to replicate it.
 
 Useful Information 
 - Operating System (MacOS/Windows/Linux)
@@ -36,21 +36,21 @@ Useful Information
 
 If you've created new custom nodes that you'd like to showcase to the community, feel free to do so in our [community discussion channels](#community-discussions). If we find these nodes useful and aligned with PeekingDuck's direction, we'll work with you to incorporate them into the core PeekingDuck package!
 
-If you have suggestions for new **non-node** PeekingDuck features, please open an [issue](https://github.com/aimakerspace/PeekingDuck/issues), describe the feature and why it could be useful to PeekingDuck users.
+If you have suggestions for new **non-node** PeekingDuck features, please open an [issue](https://github.com/aisingapore/PeekingDuck/issues), describe the feature and why it could be useful to PeekingDuck users.
 
 ### Code Contributions
 
 Here is a guide of the general steps to contribute code to PeekingDuck.
 
 - Own an issue from the issues board. This is to prevent duplicate work.
 
-  1. Pick an issue from our [issues tracker](https://github.com/aimakerspace/PeekingDuck/issues) and indicate your interest to work on the issue.
+  1. Pick an issue from our [issues tracker](https://github.com/aisingapore/PeekingDuck/issues) and indicate your interest to work on the issue.
   2. If there are no one else working on the issue, the maintainer will assign the issue to you.
   3. After receiving the confirmation from the maintainer, you may begin work on the issue.
 
 - Contributing code 
   1. Do read our [code styles guidelines](#code-styles).
-  2. [Fork](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) the aimakerspace/PeekingDuck repository. For more details in this process, Jake Jarvis has a [useful guide](https://jarv.is/notes/how-to-pull-request-fork-github/) that describes steps 2-6 and 10 in more detail.
+  2. [Fork](https://docs.github.com/en/github/getting-started-with-github/quickstart/fork-a-repo) the aisingapore/PeekingDuck repository. For more details in this process, Jake Jarvis has a [useful guide](https://jarv.is/notes/how-to-pull-request-fork-github/) that describes steps 2-6 and 10 in more detail.
   3. Clone the forked branch to your local machine.
   4. \[Recommended\] track the original repository as another remote. After which you will be able to receive updates using `git fetch`. This is useful for long term contributions to the repository.
   5. In your local repository, create a descriptive branch to work on your issue.
@@ -65,7 +65,7 @@ Thank you for your contributions!!
 
 ## Community Discussions
 
-Join us in our [GitHub discussion board](https://github.com/aimakerspace/PeekingDuck/discussions) or [AI Singapore's Community forum](https://community.aisingapore.org/groups/computer-vision/forum/).
+Join us in our [GitHub discussion board](https://github.com/aisingapore/PeekingDuck/discussions) or [AI Singapore's Community forum](https://community.aisingapore.org/groups/computer-vision/forum/).
 
 Post your thread regarding
 
@@ -139,8 +139,8 @@ The following are commonly used conventions which we adhere to:
   - Private/internal functions and methods can have less detailed docstrings, with optional `Args` and `Returns`
   - `__init__` methods do not require docstrings
   - Avoid inline comments if the line width limit is exceeded as it causes the code to be wrapped
-  - Example of a class docstring including Read the Docs info: [yolo.py](https://github.com/aimakerspace/PeekingDuck/blob/main/peekingduck/pipeline/nodes/model/yolo.py)
-  - Example of a function/method docstring: [checker.py](https://github.com/aimakerspace/PeekingDuck/blob/main/peekingduck/weights_utils/checker.py)
+  - Example of a class docstring including Read the Docs info: [yolo.py](https://github.com/aisingapore/PeekingDuck/blob/main/peekingduck/pipeline/nodes/model/yolo.py)
+  - Example of a function/method docstring: [transforms.py](https://github.com/aimakerspace/PeekingDuck/blob/main/peekingduck/pipeline/utils/bbox/transforms.py)
 - Type Hints
   - Use `pathlib.Path` type for arguments that are full paths (such as variables with `_dir` and `_path` postfixes) instead of `str`
   - Avoid using `#type: ignore` as much as possible - declare variable type instead

README.md

@@ -1,13 +1,13 @@
 <br />
 
-<img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/peekingduck.svg">
+<img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/peekingduck.svg">
 
 ---
 
 [![Python version](https://img.shields.io/badge/python-3.6%20%7C%203.7%20%7C%203.8%20%7C%203.9-blue.svg)](https://pypi.org/project/peekingduck/)
 [![PyPI version](https://badge.fury.io/py/peekingduck.svg)](https://pypi.org/project/peekingduck/)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/peekingduck)](https://pypi.org/project/peekingduck/)
-[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/aimakerspace/PeekingDuck/blob/main/LICENSE)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/aisingapore/PeekingDuck/blob/main/LICENSE)
 [![Documentation Status](https://readthedocs.org/projects/peekingduck/badge/?version=stable)](https://peekingduck.readthedocs.io/en/stable/?badge=stable)
 
 <h4 align="center">
@@ -19,7 +19,7 @@
   <span> · </span>
   <a href="https://peekingduck.readthedocs.io/en/stable/faq.html">FAQ</a>
   <span> · </span>
-  <a href="https://github.com/aimakerspace/PeekingDuck/issues">Report a bug</a>
+  <a href="https://github.com/aisingapore/PeekingDuck/issues">Report a bug</a>
   <span> · </span>
   <a href="#communities">Communities</a>
 </h4>
@@ -61,7 +61,7 @@ PeekingDuck can also be [installed in a virtual environment](https://peekingduck
 ```
 
 You should see a video of a person waving his hand with
-[bounding boxes overlaid](https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/getting_started/verify_install.gif).
+[bounding boxes overlaid](https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/getting_started/verify_install.gif).
 
 The video will close automatically when it is run to the end, select the video window and press `q` to exit earlier.
 
@@ -82,7 +82,7 @@ Run the demo pipeline.
 ```
 
 If you have a webcam, you should see a man waving on the output screen with
-[skeletal frame overlaid](https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/getting_started/default_pipeline.gif).
+[skeletal frame overlaid](https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/getting_started/default_pipeline.gif).
 
 Terminate the program by clicking on the output screen and pressing `q`.
 
@@ -96,44 +96,44 @@ Gallery
   <tr>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/social_distancing.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/social_distancing.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/social_distancing.gif">
       </a>
     </td>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/privacy_protection_faces.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/privacy_protection_faces.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/privacy_protection_faces.gif">
       </a>
     </td>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/zone_counting.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/zone_counting.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/zone_counting.gif">
       </a>
     </td>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/object_counting_over_time.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/object_counting_over_time.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/object_counting_over_time.gif">
       </a>
     </td>
   </tr>
   <tr>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/group_size_checking.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/group_size_checking.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/group_size_checking.gif">
       </a>
     </td>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/privacy_protection_license_plates.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/privacy_protection_license_plates.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/privacy_protection_license_plates.gif">
       </a>
     </td>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/crowd_counting.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/crowd_counting.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/crowd_counting.gif">
       </a>
     </td>
     <td>
       <a href="https://peekingduck.readthedocs.io/en/stable/use_cases/people_counting_over_time.html">
-        <img src="https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/docs/source/assets/use_cases/people_counting_over_time.gif">
+        <img src="https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/docs/source/assets/use_cases/people_counting_over_time.gif">
       </a>
     </td>
   </tr>
@@ -149,7 +149,7 @@ This project is supported by the National Research Foundation, Singapore under i
 License
 -------
 
-PeekingDuck is under the open source [Apache License 2.0](https://github.com/aimakerspace/PeekingDuck/blob/main/LICENSE) (:
+PeekingDuck is under the open source [Apache License 2.0](https://github.com/aisingapore/PeekingDuck/blob/main/LICENSE) (:
 
 Even so, your organization may require legal proof of its right to use PeekingDuck, due to circumstances such as the following:
 - Your organization is using PeekingDuck in a jurisdiction that does not recognize this license
@@ -163,4 +163,4 @@ Communities
 -----------
 
 - [AI Singapore community forum](https://community.aisingapore.org/groups/computer-vision/forum/)
-- [Discuss on GitHub](https://github.com/aimakerspace/PeekingDuck/discussions)
+- [Discuss on GitHub](https://github.com/aisingapore/PeekingDuck/discussions)

docs/source/faq.rst

@@ -45,4 +45,4 @@ Why does the output screen flash briefly and disappear on my second run?
 
 If you are running PeekingDuck on the Windows Subsystem for Linux (WSL), this erroneous behavior
 may be caused by a WSL bug where the key buffer is not flushed. Please refer to this
-`GitHub issue <https://github.com/aimakerspace/PeekingDuck/issues/630>`_ for more details.
+`GitHub issue <https://github.com/aisingapore/PeekingDuck/issues/630>`_ for more details.

docs/source/getting_started/03_custom_install.rst

@@ -15,7 +15,7 @@ Arm64
 To install PeekingDuck on an ARM-based device, such as a Raspberry Pi, include
 the ``--no-dependencies`` flag, and separately install the other dependencies
 listed in PeekingDuck's `[requirements.txt]
-<https://github.com/aimakerspace/PeekingDuck/blob/main/requirements.txt>`_:
+<https://github.com/aisingapore/PeekingDuck/blob/main/requirements.txt>`_:
 
 .. admonition:: Terminal Session
 

docs/source/index.rst

@@ -12,7 +12,7 @@ Introduction
    :target: https://pypi.org/project/peekingduck
 
 .. image:: https://img.shields.io/badge/license-Apache%202.0-blue.svg
-   :target: https://github.com/aimakerspace/PeekingDuck/blob/main/LICENSE
+   :target: https://github.com/aisingapore/PeekingDuck/blob/main/LICENSE
 
 
 What is PeekingDuck?
@@ -86,7 +86,7 @@ Foundation, Singapore.
 License
 =======
 
-PeekingDuck is under the open source `Apache License 2.0 <https://github.com/aimakerspace/PeekingDuck/blob/main/LICENSE>`_ (:
+PeekingDuck is under the open source `Apache License 2.0 <https://github.com/aisingapore/PeekingDuck/blob/main/LICENSE>`_ (:
 
 Even so, your organization may require legal proof of its right to use PeekingDuck, due to
 circumstances such as the following:
@@ -103,4 +103,4 @@ Communities
 ===========
 
 * `AI Singapore community forum <https://community.aisingapore.org/groups/computer-vision/forum/>`_
-* `Discuss on GitHub <https://github.com/aimakerspace/PeekingDuck/discussions>`_
+* `Discuss on GitHub <https://github.com/aisingapore/PeekingDuck/discussions>`_

docs/source/tutorials/01_hello_cv.rst

@@ -174,7 +174,7 @@ To get a quick overview of PeekingDuck's nodes, run the following command:
    | \ :blue:`[~user]` \ > \ :green:`peekingduck nodes` \
 
 
-.. url: https://raw.githubusercontent.com/aimakerspace/PeekingDuck/main/images/tutorials/ss_pkd_nodes.png
+.. url: https://raw.githubusercontent.com/aisingapore/PeekingDuck/main/images/tutorials/ss_pkd_nodes.png
 .. image:: /assets/tutorials/ss_pkd_nodes.png
    :alt: PeekingDuck screenshot : nodes output
 

docs/source/tutorials/05_calling_peekingduck_in_python.rst

@@ -185,7 +185,7 @@ configuration, you can pass the new values to the ``Node()`` constructor as keyw
 
 
 Lines 25 - 37: Initialize the PeekingDuck ``Runner`` from
-`runner.py <https://github.com/aimakerspace/PeekingDuck/blob/main/peekingduck/runner.py>`_ with the
+`runner.py <https://github.com/aisingapore/PeekingDuck/blob/main/peekingduck/runner.py>`_ with the
 list of nodes passed in via the ``nodes`` argument.
 
 .. note::
@@ -254,7 +254,7 @@ In this demo, we will show how users can construct a custom PeekingDuck pipeline
     * Visualization packages such as `matplotlib <https://pypi.org/project/matplotlib/>`_.
 
 The notebook corresponding to this tutorial, ``calling_peekingduck_in_python.ipynb``, can be found in the
-`notebooks <https://github.com/aimakerspace/PeekingDuck/tree/main/notebooks>`_ folder of the
+`notebooks <https://github.com/aisingapore/PeekingDuck/tree/main/notebooks>`_ folder of the
 PeekingDuck repository and is also available as a
 `Colab notebook <https://colab.research.google.com/drive/1NwQKrnY_3ia2mBEaUinkvUqbrjjT3ssq#scrollTo=l2MCyh5Hgp5O>`_.
 

docs/source/use_cases/_template_use_case.rst

@@ -28,7 +28,7 @@ Demo
     Replace <use_case_config> with the actual name
 
 .. |pipeline_config| replace:: <use_case_config>.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/<use_case_config>.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/<use_case_config>.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/01_installation>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/crowd_counting.rst

@@ -23,7 +23,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: crowd_counting.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/crowd_counting.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/crowd_counting.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/face_mask_detection.rst

@@ -21,7 +21,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: face_mask_detection.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/face_mask_detection.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/face_mask_detection.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/group_size_checking.rst

@@ -27,7 +27,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: group_size_checking.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/group_size_checking.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/group_size_checking.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/object_counting_over_time.rst

@@ -38,7 +38,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: object_counting_over_time.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/object_counting_over_time.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/object_counting_over_time.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/object_counting_present.rst

@@ -32,7 +32,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: object_counting_present.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/object_counting_present.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/object_counting_present.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/people_counting_over_time.rst

@@ -22,7 +22,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: people_counting_over_time.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/people_counting_over_time.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/people_counting_over_time.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown:

docs/source/use_cases/privacy_protection_faces.rst

@@ -20,7 +20,7 @@ Demo
 ====
 
 .. |pipeline_config| replace:: privacy_protection_faces.yml
-.. _pipeline_config: https://github.com/aimakerspace/PeekingDuck/blob/main/use_cases/privacy_protection_faces.yml
+.. _pipeline_config: https://github.com/aisingapore/PeekingDuck/blob/main/use_cases/privacy_protection_faces.yml
 
 To try our solution on your own computer, :doc:`install </getting_started/02_standard_install>` and run
 PeekingDuck with the configuration file |pipeline_config|_ as shown: