toad icon indicating copy to clipboard operation
toad copied to clipboard

[ENH]建议添加一个开发者文档

Open peterpanmj opened this issue 3 years ago • 1 comments

我觉得项目很有用,听说很多公司在生产中使用。我在简单浏览后发现了一些我觉得可以改进的地方,但是没有contribution guide或者developer guide。有点无从下手,比如修改后在哪里添加unit test,遵从什么style(放松了很多pep8)。希望维护者能添加一个开发者文档(有英文就够了,中英文都有更好),让全世界更多开发者能加入到这个项目。

我现在发现的几个疑问

  • https://github.com/amphibian-dev/toad/blob/9aa755273c8fc055c8a244f244e5437c189aa884/toad/stats.py#L291 这里indicators的default值是[]而不是None, 这一般是不建议的做法。这么做是有原因的吗?
  • https://github.com/amphibian-dev/toad/blob/9aa755273c8fc055c8a244f244e5437c189aa884/toad/stats.py#L425-L426 这里IV可以直接利用woe结果但是又重复算了一遍。另外pd.DataFrame.apply在数值计算中一般避免使用(效率低)。直接用(table['y_prop'] - table['n_prop']) * np.log(table['y_prop']/table['n_prop'])或者(table['y_prop'] - table['n_prop']) * WOE(table['y_prop'],table['n_prop'])应该会更加简洁高效吧?
  • 还是style不一致,‘,axis=1’和‘,axis=1’共存,可以改进一下,加个linting?
  • 习惯len(np.array),不喜欢 np.array.size和np.size(),这个不明白
  • 测试的脚本好多assertion,看不太懂,也不知道添加test怎么弄。

有个contribution guide就好了。然后我们分几个issue来讨论。

peterpanmj avatar May 18 '22 17:05 peterpanmj

@peterpanmj 非常感觉你的反馈,因为之前基本都是单人开发,所以还没有准备开发者文档,我近期会开始着手准备开发者文档。对于提到的改进的地方,非常欢迎提交PR进行改善~ 我一会儿会先开一个 contribution guide的issue,可以反馈相关开发问题~

Secbone avatar Jun 06 '22 02:06 Secbone