Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added How to Install Dependencies + Common Issue Section to README.md #46

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,61 @@ February 2015 and notify the authors.
To use the evaluation script (metrics.py): see
[coco-caption](https://github.com/tylin/coco-caption) for the requirements.

## How to Install Dependencies
Go to your terminal or command line and type each of the commands below:

```
pip install numpy
pip install scikit-learn
pip install scikit-image
pip install argparse
pip install theano
```
## Common Issues and How to Solve them
### cPickle import issue
In some files there will be an import statement like this:

`import cPickle as pkl`

that might give you an error statement when you try to run any files within this repository

If you have tried:

`pip install cPickle`

and that command results in an error message:

```
ERROR: Could not find a version that satisfies the requirement cPickle (from versions: none)
ERROR: No matching distribution found for cPickle
```
Then change "cPickle" to "pickle" as shown below:

`import pickle as pkl`

cPickle is just a faster version of pickle, so this should work as an alternative

### Theano Issue
As the `Dependencies` section stated, if you ran into issues with Theano then you would need to revert back to a previous commit.

To do this, first do:

`git log`

This will show the previous commits, if you want to see more commits then press the spacebar or the enter key. Once you found the right commit,
press "q" to get out of `git log`.

Then, copy the combination of letters and digits after "commit" on the commit you want to revert back to, for example for `commit de281cebfb9965cc53873f9dd92e6eca418dc4a7` you only want to copy `de281cebfb9965cc53873f9dd92e6eca418dc4a7`.

Then type in `git reset` and paste the thing you copied a space after that, for example:

`git reset de281cebfb9965cc53873f9dd92e6eca418dc4a7`

And that should revert you back to a previous copy.

### Errors with print statements
If you are having errors related to some print statements in this codebase, then you should put the strings/variables in the same line as `print` inside of parentheses

## Reference

If you use this code as part of any published research, please acknowledge the
Expand Down