AI-Feynman icon indicating copy to clipboard operation
AI-Feynman copied to clipboard

comment fixes, README updates, remove extra sympy imports

Open phiat opened this issue 4 years ago • 0 comments

👍 Thanks for posting this project 👍. Trying to learn some of the techniques and ended up fixing some minor spelling and comment formatting. Only non-comment change is removing an extra sympy import.

did:

  • capitalize and space out comments (did not capitalize commented code)
    • #this function does x ... -> # This function does x
  • fix minor spelling and grammar
  • fix other minor comment inconsistencies
  • add TODO # TODO: Fix this to work with the other variables constant (S_gen_sym.py)
  • add wiki link for Pareto Frontier to README
  • fix README example verbiage to match example parameters (30 vs 60)
  • remove extra sympy imports (Edit: noticed this is in a few functions. Only removed one instance. still need to remove others)
  • add MIT license badge to README
  • convert some """ multiline comments """ -> # single line
  • add newline to start of multiline comments

did not:

  • remove these lines (maybe you want them) ###############################################
  • change wording of author(s)
  • remove: # In[2]: (get_pareto.py:44)

questions:

  • where is: "ai_feynman_example.py contains an example of running the code on some examples (found in the example_data directory)" ?
  • would you want a little more thorough code reformat / refactor (move hardcoded strings/paths to config)? I am not a python guru, but will give it a go.
  • is this repo meant to be maintained somewhat (are you accepting PRs)? Or should I just fork and run with it? Thanks again

phiat avatar Oct 27 '20 04:10 phiat