mirror of
https://github.com/facebookresearch/pytorch3d.git
synced 2025-12-14 11:26:24 +08:00
Setup website with docusaurus (#11)
Summary: Set up landing page, docs page, and html versions of the ipython notebook tutorials. Pull Request resolved: https://github.com/fairinternal/pytorch3d/pull/11 Reviewed By: gkioxari Differential Revision: D19730380 Pulled By: nikhilaravi fbshipit-source-id: 5df8d3f2ac2f8dce4d51f5d14fc336508c2fd0ea
This commit is contained in:
committed by
Facebook Github Bot
parent
e290f87ca9
commit
15d3a4557e
49
website/pages/tutorials/index.js
Normal file
49
website/pages/tutorials/index.js
Normal file
@@ -0,0 +1,49 @@
|
||||
/**
|
||||
* Copyright (c) Facebook, Inc. and its affiliates.
|
||||
* @format
|
||||
**/
|
||||
|
||||
const React = require('react');
|
||||
|
||||
const CWD = process.cwd();
|
||||
|
||||
const CompLibrary = require(`${CWD}/node_modules/docusaurus/lib/core/CompLibrary.js`);
|
||||
const Container = CompLibrary.Container;
|
||||
const MarkdownBlock = CompLibrary.MarkdownBlock;
|
||||
|
||||
const TutorialSidebar = require(`${CWD}/core/TutorialSidebar.js`);
|
||||
const bash = (...args) => `~~~bash\n${String.raw(...args)}\n~~~`;
|
||||
|
||||
class TutorialHome extends React.Component {
|
||||
render() {
|
||||
return (
|
||||
<div className="docMainWrapper wrapper">
|
||||
<TutorialSidebar currentTutorialID={null} />
|
||||
<Container className="mainContainer documentContainer postContainer">
|
||||
<div className="post">
|
||||
<header className="postHeader">
|
||||
<h1 className="postHeaderTitle">Welcome to the PyTorch3D Tutorials</h1>
|
||||
</header>
|
||||
<p>
|
||||
Here you can learn about the structure and applications of Pytorch3D from
|
||||
examples which are in the form of ipython notebooks.
|
||||
</p>
|
||||
<h3> Run interactively </h3>
|
||||
<p>
|
||||
At the top of each example you can find a button named <strong>"Open in Colab"</strong> which will open the notebook in <a href="https://colab.research.google.com/notebooks/intro.ipynb"> Google Colaboratory </a> where you can run the code directly in the browser with access to GPU support e.g.
|
||||
</p>
|
||||
<img align="center" src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
|
||||
<p> You can modify the code and experiment with varying different settings.
|
||||
Remember to install pytorch, torchvision, fvcore and pytorch3d in the first cell of the colab notebook by running: </p>
|
||||
<MarkdownBlock>{bash`!pip install torch torchvision
|
||||
!pip install 'git+https://github.com/facebookresearch/pytorch3d.git`}</MarkdownBlock>
|
||||
<h3> Run locally </h3>
|
||||
<p> There is also a button to download the notebook and source code to run it locally. </p>
|
||||
</div>
|
||||
</Container>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = TutorialHome;
|
||||
Reference in New Issue
Block a user