Skip to content

Commit

Permalink
Merge pull request #3916 from 0xSushmanth/patch-1
Browse files Browse the repository at this point in the history
Fix Readme in Windows Support section
  • Loading branch information
jph00 committed May 26, 2023
2 parents bccc3fe + 2ba95cc commit 7176ffb
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 2 deletions.
6 changes: 5 additions & 1 deletion README.md
Expand Up @@ -131,9 +131,13 @@ you on your way:
## Windows Support

When installing with `mamba` or `conda` replace `-c fastchan` in the
installation with `-c pytorch -c nvidia -c fastai`, since fastchan is
installation with `-c nvidia`, since fastchan is
not currently supported on Windows.

``` bash
conda install -c nvidia fastai anaconda
```

Due to python multiprocessing issues on Jupyter and Windows,
`num_workers` of `Dataloader` is reset to 0 automatically to avoid
Jupyter hanging. This makes tasks such as computer vision in Jupyter on
Expand Down
37 changes: 36 additions & 1 deletion nbs/index.ipynb
Expand Up @@ -12,6 +12,7 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -22,20 +23,23 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"![CI](https://github.com/fastai/fastai/workflows/CI/badge.svg) [![PyPI](https://img.shields.io/pypi/v/fastai?color=blue&label=pypi%20version)](https://pypi.org/project/fastai/#description) [![Conda (channel only)](https://img.shields.io/conda/vn/fastai/fastai?color=seagreen&label=conda%20version)](https://anaconda.org/fastai/fastai) [![Build fastai images](https://github.com/fastai/docker-containers/workflows/Build%20fastai%20images/badge.svg)](https://github.com/fastai/docker-containers) ![docs](https://github.com/fastai/fastai/workflows/docs/badge.svg)"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Installing"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand Down Expand Up @@ -64,13 +68,15 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Learning fastai"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -84,13 +90,15 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## About fastai"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -107,20 +115,23 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"<img alt=\"Layered API\" src=\"images/layered.png\" width=\"345\">"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Migrating from other libraries"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -133,26 +144,46 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Windows Support\n",
"\n",
"When installing with `mamba` or `conda` replace `-c fastchan` in the installation with `-c pytorch -c nvidia -c fastai`, since fastchan is not currently supported on Windows.\n",
"When installing with `mamba` or `conda` replace `-c fastchan` in the installation with `-c nvidia`, since fastchan is not currently supported on Windows.\n"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"```bash\n",
"conda install -c nvidia fastai anaconda\n",
"```"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"Due to python multiprocessing issues on Jupyter and Windows, `num_workers` of `Dataloader` is reset to 0 automatically to avoid Jupyter hanging. This makes tasks such as computer vision in Jupyter on Windows many times slower than on Linux. This limitation doesn't exist if you use fastai from a script.\n",
"\n",
"See [this example](https://github.com/fastai/fastai/blob/master/nbs/examples/dataloader_spawn.py) to fully leverage the fastai API on Windows."
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Tests"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -168,13 +199,15 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Contributing"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand All @@ -184,13 +217,15 @@
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Docker Containers"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
Expand Down

0 comments on commit 7176ffb

Please sign in to comment.