Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 9f3a244

Browse files
committed
update README.md
1 parent 4dbea0e commit 9f3a244

File tree

1 file changed

+13
-4
lines changed

1 file changed

+13
-4
lines changed

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,21 @@
1-
# aima-python
1+
# aima-python: Structure of the Project
22

3-
Python 3 code for the book *Artificial Intelligence: A Modern Approach.*
3+
Python code for the book *Artificial Intelligence: A Modern Approach.*
4+
When complete, this project will cover all the major topics in the book, for each topic, such as `logic`, we will have the following [Python 3.5](https://www.python.org/downloads/release/python-350/) files:
45

5-
Eventually, this repository should have code for everything in the book.
6+
- `logic.py`: Implementations of all the pseudocode algorithms in the book.
7+
- `logic_test.py`: A lightweight test suite, using `assert` statements, designed for use with `py.test`.
8+
- `logic.ipynb`: A Jupyter notebook, with examples of usage. Does a `from logic import *` to get the code.
69

710
# Style Guide
811

9-
We default to [Pep 8](https://www.python.org/dev/peps/pep-0008), but with a few exceptions:
12+
There are a few style rules that are unique to this project:
13+
14+
- The first rule is that the code should correspond directly to the pseudocode in the book. When possible this will be almost one-to-one, just allowing for the syntactic differences between Python and pseudocode, and for different library functions.
15+
- Don't make a function more complicated than the pseudocode in the book, even if the complication would add a nice feature, or give an efficiency gain. Instead, remain faithful to the pseudocode, and if you must, add a new function (not in the book) with the added feature.
16+
- I use functional programming in many cases, but not exclusively; let the book's pseudocode be the guide. In general, pure functions (with no side effects) are prefered, but functions with side effects, and classes, can be used where appropriate.
17+
18+
Beyond the above rules, we default to [Pep 8](https://www.python.org/dev/peps/pep-0008), with a few minor exceptions:
1019

1120
- I'm not too worried about an occasional line longer than 79 characters.
1221
- You don't need two spaces after a sentence-ending period.

0 commit comments

Comments
 (0)