Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Typescript Migration #24

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

imoxto
Copy link
Collaborator

@imoxto imoxto commented Mar 23, 2023

PR for Migrating to Typescript (#7).

Features:

  • Type definitions available for consumable functions
  • Support es module imports

Lackings:

  • support commonjs module requires
  • documentation on how to install, build.

@imoxto imoxto requested review from arionrefat and rk-teche March 23, 2023 10:39
@rk-teche rk-teche changed the title Migrate to typescript [WIP] [WIP] Typescript Migration Mar 23, 2023
@@ -2,12 +2,14 @@
"name": "promptifyjs",
"version": "0.0.1",
"description": "Prompt Engineering, Solve NLP Problems with LLM's & Easily generate different NLP Task prompts for popular generative models like GPT, PaLM, and more with Promptify",
"main": "index.js",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is no dist/index.js file in the build output. We should create an index.ts file inside src first.

@@ -3,6 +3,11 @@ export const binaryClassification = ({
description = "",
labels = "",
examples = [],
}: {
text_input?: string;
description?: string;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

description is not optional. There are a few keys that are required at all times.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are duplicating the same prompt section. Please conditionally generate the prompt based on whether domain is available or not

@Devorein
Copy link
Collaborator

There are a few places where we are using ? (optional) for required parameters. Please update those.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants