Skip to content

Commit 1ff5471

Browse files
committed
update contribute and readme.
1 parent 20975c1 commit 1ff5471

File tree

6 files changed

+84
-21
lines changed

6 files changed

+84
-21
lines changed

01_base/01.string.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,7 @@
44
@author:XuMing
55
"""
66

7-
8-
7+
# 字符串的索引
98
s = 'good morning'
109
print(s[0]) # g
1110

07_data_science/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# Data Science
22

3-
常用机器学习库之间的关系
3+
常用数据科学库之间的关系
44

55
![data_science](../docs/imgs/scipy-image.jpg)

CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Contributing
2+
3+
We are happy to accept your contributions to make `python-tutorial` better and more awesome! To avoid unnecessary work on either
4+
side, please stick to the following process:
5+
6+
1. Check if there is already [an issue](https://github.com/shibing624/python-tutorial/issues) for your concern.
7+
2. If there is not, open a new one to start a discussion. We hate to close finished PRs!
8+
3. If we decide your concern needs code changes, we would be happy to accept a pull request. Please consider the
9+
commit guidelines below.

README.md

Lines changed: 72 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
# python-tutorial
2+
3+
[![PyPI version](https://badge.fury.io/py/python-tutorial.svg)](https://badge.fury.io/py/python-tutorial)
4+
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
5+
[![GitHub contributors](https://img.shields.io/github/contributors/shibing624/python-tutorial.svg)](https://github.com/shibing624/python-tutorial/graphs/contributors)
6+
[![License Apache 2.0](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
7+
[![python_vesion](https://img.shields.io/badge/Python-3.5%2B-green.svg)](requirements.txt)
8+
[![GitHub issues](https://img.shields.io/github/issues/shibing624/python-tutorial.svg)](https://github.com/shibing624/python-tutorial/issues)
9+
[![Wechat Group](http://vlog.sfyc.ltd/wechat_everyday/wxgroup_logo.png?imageView2/0/w/60/h/20)](#Contact)
10+
11+
212
python教程,包括:python基础、numpy、scipy、python进阶、matplotlib、OOP、tensorflow、keras、pandas、NLP analysis.
313

414

515

6-
在本Python教程包含了一些范例,涵盖了大多数常见Python日常脚本任务,是入门Python的学习资料,也可以作为工作中上手Python的参考实现。
16+
在本Python教程包含了一些范例,涵盖了大多数常见Python日常脚本任务,是入门Python的学习资料,也可以作为工作中编写Python脚本的参考实现。
17+
以下所有实现均在python3环境下测试。
18+
719

20+
**Guide**
821

9-
## nlp-tutorial的例子清单
22+
- [Tutorial](#python-tutorial的例子清单)
23+
- [Get Started](#get-started)
24+
- [Contact](#Contact)
25+
- [Cite](#Cite)
26+
- [Reference](#reference)
1027

11-
| **目录** | **主题** | 简要说明 |
12-
| --------------------- | ------------------------------------------------------------ | ------------------------------------------------------------ |
28+
29+
# python-tutorial的例子清单
30+
31+
| **目录** | **主题** | 简要说明 |
32+
| --------------------- | -------------------------------------------- | ---------------------------- |
1333
| 01_base | Python基础 | 提供了数据类型、字符串、list、条件判断、循环的使用例子。 |
1434
| 02_advanced | Python高级特性 | 提供了切片、迭代、生成器、迭代器的使用例子。 |
1535
| 03_oop | 面向对象编程 | 提供了多重继承、定制类、枚举类、设计模式的使用例子。 |
@@ -56,4 +76,51 @@ xgboost 文本分类
5676

5777

5878
[xgb_lr.py](xgb_lr.py)
59-
xgboost 提取特征之间的关系,再用lr文本分类
79+
xgboost 提取特征之间的关系,再用lr文本分类
80+
81+
# Get Started
82+
83+
84+
85+
86+
# Contact
87+
88+
- Issue(建议):[![GitHub issues](https://img.shields.io/github/issues/shibing624/python-tutorial.svg)](https://github.com/shibing624/python-tutorial/issues)
89+
- 邮件我:xuming: xuming624@qq.com
90+
- 微信我:
91+
加我*微信号:xuming624, 备注:个人名称-NLP* 进Python-NLP交流群。
92+
93+
<img src="docs/wechat.jpeg" width="200" />
94+
95+
96+
# Cite
97+
98+
如果你在研究中使用了python-tutorial,请按如下格式引用:
99+
100+
```latex
101+
@software{python-tutorial,
102+
author = {Xu Ming},
103+
title = {python-tutorial: Python3 Tutorial for Get Started Developer},
104+
year = {2021},
105+
url = {https://github.com/shibing624/python-tutorial},
106+
}
107+
```
108+
109+
# License
110+
111+
112+
授权协议为 [The Apache License 2.0](/LICENSE),可免费用做商业用途。请在产品说明中附加python-tutorial的链接和授权协议。
113+
114+
115+
# Contribute
116+
项目代码还很粗糙,如果大家对代码有所改进,欢迎提交回本项目,在提交之前,注意以下两点:
117+
118+
- 在本地进行单元测试
119+
- 确保所有单测都是通过的
120+
121+
之后即可提交PR。
122+
123+
# Reference
124+
125+
1. [缪雪峰Python3教程](https://www.liaoxuefeng.com/wiki/1016959663602400)
126+
2. [PythonDataScienceHandbook](https://github.com/jakevdp/PythonDataScienceHandbook)

docs/wechat.jpeg

40.2 KB
Loading

requirements.txt

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
numpy
22
scipy
33
matplotlib
4-
nltk
5-
keras
64
scikit-learn
7-
pypinyin
8-
tensorflow
9-
torch
10-
click
11-
xlearn
12-
wave
13-
pyaudio
14-
py2neo
15-
mistletoe
16-
PyYaml
17-
tornado
5+
pandas

0 commit comments

Comments
 (0)