Commit
•
586758a
1
Parent(s):
1c7eea6
Update README.md
Browse files
README.md
CHANGED
@@ -94,10 +94,10 @@ For directly using the capabilities of model without putting extra efforts on sc
|
|
94 |
|
95 |
Here's a brief overview of what can be achieved using the PipEtl library:
|
96 |
|
97 |
-
- `Function Call Generation
|
98 |
-
- `Automated Documentation Generation
|
99 |
-
- `Module Documentation
|
100 |
-
- `SQL Query Generation
|
101 |
|
102 |
For detailed usage refer to the [colab_notebook](https://colab.research.google.com/drive/17PyMU_3QN9LROy7x-jmaema0cuLRzBvc?usp=sharing)
|
103 |
|
|
|
94 |
|
95 |
Here's a brief overview of what can be achieved using the PipEtl library:
|
96 |
|
97 |
+
- `Function Call Generation` : The generate_function_call method facilitates the generation of Python function calls based on provided questions and either docstrings or undocumented code. This feature can be useful for generating example function calls or for prototyping code snippets.
|
98 |
+
- `Automated Documentation Generation` : With the generate_docstring method, users can automatically generate comprehensive docstrings for Python functions. This feature aids in maintaining well-documented codebases and adhering to best practices.
|
99 |
+
- `Module Documentation` : The generate_module_docstrings method allows for generating documentation for all methods and functions within a given module or package. This capability streamlines the documentation process, especially for large codebases with numerous functions.
|
100 |
+
- `SQL Query Generation` : Users can leverage the generate_sql method to automatically generate SQL queries based on provided schemas and questions. This functionality simplifies the process of creating SQL queries, particularly for data-related tasks.
|
101 |
|
102 |
For detailed usage refer to the [colab_notebook](https://colab.research.google.com/drive/17PyMU_3QN9LROy7x-jmaema0cuLRzBvc?usp=sharing)
|
103 |
|