Skip to content

Commit f2df87a

Browse files
committed
Update README
1 parent ddc81a6 commit f2df87a

File tree

1 file changed

+1
-35
lines changed

1 file changed

+1
-35
lines changed

README.md

+1-35
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,3 @@
11
# fastai_dev
22

3-
This repo is used for fastai development. fastai v2 is being developed in the `dev` folder. Docs are at http://dev.fast.ai .
4-
5-
## Installation
6-
7-
You can get all the necessary dependencies by simply installing fastai v1: `conda install -c fastai -c pytorch fastai`. Or alternatively you can automatically install the dependencies into a new environment:
8-
9-
```bash
10-
cd fastai_dev
11-
conda env create -f environment.yml
12-
```
13-
14-
Then, you can install fastai v2 with pip: `pip install git+https://github.com/fastai/fastai_dev`. Or clone this repo, cd to its directory, and `pip install -e .` for an *editable install* (which is probably the best approach at the moment, since fastai v2 is under heavy development).
15-
16-
To use `fastai2.medical.imaging` you'll also need to:
17-
18-
```bash
19-
conda install pyarrow
20-
pip install pydicom kornia opencv-python scikit-image
21-
```
22-
23-
## Tests
24-
25-
To run the tests in parallel, do something like this:
26-
27-
```bash
28-
tools/test_nbs
29-
```
30-
31-
## Contributing
32-
33-
After you clone this repository, please run `tools/run-after-git-clone` in your terminal. This sets up git hooks, which clean up the notebooks to remove the extraneous stuff stored in the notebooks (e.g. which cells you ran) which causes unnecessary merge conflicts.
34-
35-
Before submitting a PR, check that the local library and notebooks match. The script `diff_nb_script.py` can let you know if there is a difference between the local library and the notebooks.
36-
* If you made a change to the notebooks in one of the exported cells, you can export it to the library with `notebook2script.py`.
37-
* If you made a change to the library, you can export it back to the notebooks with `script2notebook.py`.
3+
This repo is used for fastai development. If you're looking for the version 2 of the fastai library, go [here](https://github.com/fastai/fastai2).

0 commit comments

Comments
 (0)