public/Knight
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add code

Browse Source
This commit is contained in:
gfuse
2024-01-15 19:46:52 +01:00
parent 0567e9d3d6
commit 05a6ca84f7
2 changed files with 72 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files
NOTES.md
+54
View File
@@ -0,0 +1,54 @@
## Files
The current python code revolves around the implementation of the Cell and Player classes primarily used for creating and keeping track of move paths.
* The Cell class represents a cell on a chessboard which is capable of initiating moves. It houses a make_moves() method which generates possible new moves
from the cell's current pose.
* The Player class is a child class that inherits from Cell. The Player has additional methods for plotting paths and finding shortest paths from the source to the destination.
## Main Topics & Sub Topic References
* Scripted Graph Path Management: The focus of this script is on managing paths in a graph-like structure. It uses Cell and Player classes to map out the structure and traverse it effectively.
* Graph Rendering & Visualization: The extension to this script mainly refers to the rendering of paths into a .dot file using graphviz package. This enhances visualization of the paths generated by the script.
* Tree Traversal: The script generates possible moves from every cell, effectively generating a tree. It shapes up to be a Breadth-first search (BFS) based traversal.
* Reuse and Extend Code: All methods are generalized and can be inherited. With slight modification, you can use the Cell class for any game that has movement defined in x-y coordinates. For further extension, you can inherit from these classes and define custom movements.
Extending the Current Script
* Render Graphs in Realtime: While currently the paths are getting saved in a '.dot' file, it is possible to extend the script to render the graph in real time, using libraries like matplotlib.
* Calculate Shortest Path: A method can be added to not just store all possible paths but calculate the shortest path between the Player and target cells.
* Add Error Handling: Add further error handling to check if destination provided by user is within board limits and if there's any possible path beforehand.
* Add User Interface: For ease of use, a graphical user interface could be implemented where users can interactively put in their source and target cells and the script would visually lay out the shortest path.
## Creating a Dataset for a Classifier for Valid Knight Moves
* Data Structure: You could structure each observation in the dataset as a pair (or "tuple") of positions (x, y), which represent the board position of the knight and the potential move to a target square.
* Positive Examples: Start by generating a set of valid moves. For each position on the board, calculate where a knight's valid moves would land you. Each of these represents a positive example in your training set, a valid move.
* Negative Examples: For negative examples, you may consider moves that land outside of the chess board or moves that are not L-shaped (2 squares in one direction, 1 square in the perpendicular direction).
* Labels: Your dataset should have labels marking whether a particular move is valid or not. Once you have a sizable dataset, you could feed this into a classification model to identify whether potential knight moves are valid or not.
## The existing script can be transformed into a secure cloud service using myriad of cloud providers such as AWS, Google Cloud Platform (GCP), Azure, etc.
Here's a general approach:
### API Development
Wrap the logic of script into an API using a web framework such as Flask or Django. This API should accept the source and target locations as inputs and return the shortest path or paths.
### Deployment
Deploy API on a cloud platform using the following steps.
1. **Infrastructure as Code**: Tools like Terraform can be used for defining and providing your infrastructure as code. This ensures your infrastructure setup is repeatable, reliable and version controlled.
2. **Containerize with Docker**: Docker can be used to create a containerized version of your application ensuring it runs identically in every environment.
3. **Manage with Kubernetes**: Kubernetes is a popular choice for deploying and managing containerized applications. It provides features for scaling and self-healing your application.
4. **Automate with CI/CD pipelines**: Incorporate Continuous Integration/Continuous Deployment pipelines to automate the building, testing and deployment of your application. Platforms such as Jenkins, GitLab CI, and CircleCI can facilitate this.
### Security
Secure API endpoints using SSL encryption (HTTPS). Use API keys or JWT tokens for the authentication and authorization of requests.
### Scaling
Take advantage of load balancing and auto-scaling features to ensure your service can handle varying loads and maintain resilience.
### Database
Consider adding a database to store users' queries and results. This can be useful for tracking and monitoring purposes, and also enables the return of cached results for previously made requests.
README.md
+18 -83
View File
@@ -1,92 +1,27 @@
# kiwifarm
The algorithm has been developed to address the following problem:
```
A knight is in a known cell on an empty chessboard and needs to reach another known cell.
Write a Python program that can take as input the two positions on the chessboard and returns as output:
* the set of all minimum-length sequences to move the piece from the initial cell to the final cell;
* a graphviz/dot file of the previous "all shortest path" graph.
```
## Getting started
You can build and run the algorithm using the run.sh file
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
### Build
To build the algorith and then run it use:
```
cd existing_repo
git remote add origin https://gitlab.gfuse.it/2024/kiwifarm.git
git branch -M main
git push -uf origin main
./run.sh build 4 5 test
```
The first element is the build or run commend that will build the container or use an already built one. then it is X and Y cordination of the destination and then the name of the output file
## Integrate with your tools
- [ ] [Set up project integrations](https://gitlab.gfuse.it/2024/kiwifarm/-/settings/integrations)
## Collaborate with your team
- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
- [ ] [Set auto-merge](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
## License
For open source projects, say how it is licensed.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
If you do not want to build it you can use:
```
./run.sh run 4 5 test
```