updating the documentation

[mohamad-tohidi]

Hello
this project seems interesting but the documentations lack explenations for what it does...

[adaamko]

Hey @mohamad-tohidi , thanks, it's still very much work in progress, so i havent updated the documentations yet. All in all it's going to be a framework that learns regex rules either from machine learning datasets or from LLM interactions, basically replacing costly LLM calls with simple white box regular expressions (or spacy rules). Check the examples or reach out to me if you have questions.

Soon I'll write more documentation for the project.

[mohamad-tohidi]

@adaamko im happy to participate
either for the documentations or the code
you can explain tasks as issues and assign or mention me (if you would add TODO's in codes that would be nice) and i will do them.

[adaamko]

Hey, i updated the documentations, so you can explore it more now :)