Skip to content

Commit

Permalink
update links to readthedoc
Browse files Browse the repository at this point in the history
  • Loading branch information
rusty1s committed Jun 29, 2019
1 parent 3bbfe02 commit cee6ba8
Show file tree
Hide file tree
Showing 7 changed files with 55 additions and 52 deletions.
91 changes: 47 additions & 44 deletions README.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/source/notes/create_dataset.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Creating Your Own Datasets
==========================

Although `PyTorch Geometric <https://github.com/rusty1s/pytorch_geometric>`_ already contains a lot of useful datasets, you may wish to create your own dataset with self-recorded or non-publicly available data.
Although PyTorch Geometric already contains a lot of useful datasets, you may wish to create your own dataset with self-recorded or non-publicly available data.

Implementing datasets by yourself is straightforward and you may want to take a look at the source code to find out how the various datasets are implemented.
However, we give a brief introduction on what is needed to setup your own dataset.
Expand Down
4 changes: 2 additions & 2 deletions docs/source/notes/installation.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Installation
============

We have outsourced a lot of functionality of `PyTorch Geometric <https://github.com/rusty1s/pytorch_geometric>`_ to other packages, which needs to be installed in advance.
We have outsourced a lot of functionality of PyTorch Geometric to other packages, which needs to be installed in advance.
These packages come with their own CPU and GPU kernel implementations based on the newly introduced `C++/CUDA extensions <https://github.com/pytorch/extension-cpp/>`_ in PyTorch 0.4.0.

.. note::
Expand Down Expand Up @@ -79,7 +79,7 @@ Please follow the steps below for a successful installation:
In rare cases, CUDA or Python path problems can prevent a successful installation.
``pip`` may even signal a successful installation, but runtime errors complain about missing modules, *.e.g.*, ``No module named 'torch_*.*_cuda'``, or execution simply crashes with ``Segmentation fault (core dumped)``.
We collected a lot of common installation errors in the `Frequently Asked Questions <https://rusty1s.github.io/pytorch_geometric/build/html/notes/installation.html#frequently-asked-questions>`_ subsection.
We collected a lot of common installation errors in the `Frequently Asked Questions <https://pytorch-geometric.readthedocs.io/en/latest/notes/installation.html#frequently-asked-questions>`_ subsection.
In case the FAQ does not help you in solving your problem, please create an `issue <https://github.com/rusty1s/pytorch_geometric/issues>`_.
You should additionally verify that your CUDA is set up correctly by following the official `installation guide <https://docs.nvidia.com/cuda/index.html>`_, and that the `official extension example <https://github.com/pytorch/extension-cpp>`_ runs on your machine.

Expand Down
4 changes: 2 additions & 2 deletions docs/source/notes/introduction.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Introduction by Example
=======================

We shortly introduce the fundamental concepts of `PyTorch Geometric <https://github.com/rusty1s/pytorch_geometric>`_ through self-contained examples.
We shortly introduce the fundamental concepts of PyTorch Geometric through self-contained examples.
At its core, PyTorch Geometric provides the following main features:

.. contents::
Expand Down Expand Up @@ -282,7 +282,7 @@ You can use it to, *e.g.*, average node features in the node dimension for each
x.size()
>>> torch.Size([32, 21])
You can learn more about scatter operations in the `documentation <http://rusty1s.github.io/pytorch_scatter>`_ of ``torch_scatter``.
You can learn more about scatter operations in the `documentation <https://pytorch-scatter.readthedocs.io>`_ of ``torch_scatter``.

Data Transforms
---------------
Expand Down
2 changes: 1 addition & 1 deletion torch_geometric/data/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ def files_exist(files):

class Dataset(torch.utils.data.Dataset):
r"""Dataset base class for creating graph datasets.
See `here <https://rusty1s.github.io/pytorch_geometric/build/html/notes/
See `here <https://pytorch-geometric.readthedocs.io/en/latest/notes/
create_dataset.html>`__ for the accompanying tutorial.
Args:
Expand Down
2 changes: 1 addition & 1 deletion torch_geometric/data/in_memory_dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
class InMemoryDataset(Dataset):
r"""Dataset base class for creating graph datasets which fit completely
into memory.
See `here <https://rusty1s.github.io/pytorch_geometric/build/html/notes/
See `here <https://pytorch-geometric.readthedocs.io/en/latest/notes/
create_dataset.html#creating-in-memory-datasets>`__ for the accompanying
tutorial.
Expand Down
2 changes: 1 addition & 1 deletion torch_geometric/nn/conv/message_passing.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ class MessagePassing(torch.nn.Module):
function, *e.g.*, sum, mean or max, and :math:`\gamma_{\mathbf{\Theta}}`
and :math:`\phi_{\mathbf{\Theta}}` denote differentiable functions such as
MLPs.
See `here <https://rusty1s.github.io/pytorch_geometric/build/html/notes/
See `here <https://pytorch-geometric.readthedocs.io/en/latest/notes/
create_gnn.html>`__ for the accompanying tutorial.
Args:
Expand Down

0 comments on commit cee6ba8

Please sign in to comment.