QuantEcon / QuantEcon/QuantEcon.py
Unify QuantEcon.py and QuantEcon.jl APIs?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 2.4k
- Forks
- 2.3k
- Avg merge
- 3d 3h
- Merged PRs (30d)
- 3
Description
One of the APIs that differ in julia and python versions is: tauchen.
Julia version is: Doc1
Python version is: Doc2
We can try to unify such APIs that differ in julia and python(like name of function arguments, position of parameters, etc.) which will help the users in migrating from one language to the other easily.
Some of the APIs are:
-
tauchenandrouwenhorst(#664 ) -
markov_chain_object.Pvsmarkov_chain_object.p
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the linked QuantEcon.jl tauchen documentation and QuantEcon.py's quantecon/markov/approximation.py around tauchen, then compare the checked tauchen and rouwenhorst items with the remaining markov_chain_object.P versus markov_chain_object.p mismatch. Done means the cross-language naming and parameter conventions are agreed and the listed API differences are resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia, python
- Domain
- api
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100