A message indicating a failure for each unit-test, should give the user a small idea of what went wrong in the test. ex: self.assertEqual ( f(values), 0, msg ='HEURISTIC MESSAGE INDICATING WHY TEST CASE FAILED')

Fixing Issue #27 , Please check the added docstrings and if the format is correct, if wrong please help me to correct the mistakes because I am a complete beginner to Google Docstrings and even large Python Codebases. Thank you and have a great day!

There are few files which contain implementation of the algorithms: [**sa,ga,hc,chaining,rs].py** you need to write the docstring for the classes present in each file using Google Docstring Convention. Refer: algorithms.py on how to write docstrings for functions and similarily refer THIS and THIS link for on getting started on how to write docstrings for the classes. PS : Google Style Guide

• [ ] chaining.py
• [ ] ga.py
• [ ] rs.py
• [ ] sa.py
• [ ] hc.py

Creating pr to reference #10

Docs should also be accessible in main branch (aka master) imo, we can autogenerate docs based on markdown files @Agrover112 inside the module/library

E.g. let's say you create a doc page in /docs branch called "Why bees can't fly" with the meta tag for doc-tag being bees

We can setup a script in main branch that when using module in ide, user can type /fliscopt help bees and will find the "intro" meta about the bees entry in the markdown file in /docs branch, as well as a link to view the documentation site

👎 Actual Behavior

A template for raising a Pullreq.

👍 Expected behavior

same as above

✍️ Suggestions to rectify this issue

Create a .yml template for creating a PR template.

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

Closes #11 @Agrover112 I have added a graphic and a logo file in the project, and updated the readme file. I have referred to the above mentioned graphics. Please mention any suggestion or changes to the graphic/logo file. I will look into it and make the necessary changes.

Seems like it's a plugin dependancy issue that's causing the build issues. @Agrover112 Docs should be ready to go, I haven't been able to get the lightweight CMS editor working BUT I'd advise setting this up with GitHub pages by tomorrow and then logging in with prose.io for now UNTIL I can fix the plugin issue

gem bundle build is the worst thing I can imagine rn.

👟 Reproduction steps

Just use the api normally and enter any combination of n_k and number_generations.

👍 Expected behavior

The number of reversals would be = iter/n_k

👎 Actual Behavior

Only 1 reversal process takes place , as seen due to default parameters, thus entered parameters are not registering.

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

Closes #39

Renamed PULL_REQUEST.md to to pull_request_template.md following these instructions https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository

This has been tested as shown in the screenshot.

What does this PR do?

Updates README.md with some missing information wrt Results tables.

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.)

Related PRs and Issues

(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.)

Have you read the Contributing Guidelines on issues?

(Write your answer here.)

Current ./run_tests.sh due to oversight were written and run using python filename.py. In order to appropriately test it , it needs yo be replaced by: pypy filename.py

👎 Actual Behavior

Failed to create or merge pull request: HttpError: Validation Failed: {"resource":"PullRequest","field":"head","code":"invalid"}

👍 Expected behavior

Should technically sync forks?

✍️ Suggestions to rectify this issue

I'm currently using secrets.TOKEN, a token which I use for the repo with public_repo permissions enabled. Not sure what is going wrong really.

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

👎 Actual Behavior

The Error isn't handled properly.

👍 Expected behavior

Should raise a particular Error (exception) when unintended input is passed to the given fn,etc.

✍️ Suggestions to rectify this issue

Add exception handling for each of the core functions and algorithms

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

👟 Reproduction steps

Implemented in: mulit_mutattion in ga_utils.py Can be tested by replacing mutation with multi_mutation in ga.py.

👍 Expected behavior

Mulit_mutattion in ga_utils.py should change N bits as selected. [1,2,3,4] for 2 bits could be: [1,3,3,5]

👎 Actual Behavior

Mulit_mutattion in ga_utils.py doesn't work as expected. Gives an Index Error when used , since the implementation is not correct.

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

Add more problems rel to current flightscheduling problem. (No matrix problems) Only problems whose solution is of the form: [1,2,3,4] OR [x1,z2..........xn] and corresponding domain : [(-a,b),(-c,-d).......nth-tuple]. Refer fitness.py for existing problems and cost functions and their domains.

Ideally the isse requires you to add a sample cost function to solve a particular problem, whose inputs are of form 1*n