Spaces:
				
			
			
	
			
			
		Runtime error
		
	
	
	
			
			
	
	
	
	
		
		
		Runtime error
		
	Commit 
							
							Β·
						
						cc48701
	
1
								Parent(s):
							
							cd47483
								
add info about deployment and usage
Browse files
    	
        README.md
    CHANGED
    
    | @@ -78,6 +78,14 @@ You can simply install the package with: | |
| 78 | 
             
            pip install synthetic-dataset-generator
         | 
| 79 | 
             
            ```
         | 
| 80 |  | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
| 81 | 
             
            ### Environment Variables
         | 
| 82 |  | 
| 83 | 
             
            - `HF_TOKEN`: Your [Hugging Face token](https://huggingface.co/settings/tokens/new?ownUserPermissions=repo.content.read&ownUserPermissions=repo.write&globalPermissions=inference.serverless.write&tokenType=fineGrained) to push your datasets to the Hugging Face Hub and generate free completions from Hugging Face Inference Endpoints.
         | 
| @@ -93,12 +101,6 @@ Optionally, you can also push your datasets to Argilla for further curation by s | |
| 93 | 
             
            - `ARGILLA_API_KEY`: Your Argilla API key to push your datasets to Argilla.
         | 
| 94 | 
             
            - `ARGILLA_API_URL`: Your Argilla API URL to push your datasets to Argilla.
         | 
| 95 |  | 
| 96 | 
            -
            ## Quickstart
         | 
| 97 | 
            -
             | 
| 98 | 
            -
            ```bash
         | 
| 99 | 
            -
            python app.py
         | 
| 100 | 
            -
            ```
         | 
| 101 | 
            -
             | 
| 102 | 
             
            ### Argilla integration
         | 
| 103 |  | 
| 104 | 
             
            Argilla is a open source tool for data curation. It allows you to annotate and review datasets, and push curated datasets to the Hugging Face Hub. You can easily get started with Argilla by following the [quickstart guide](https://docs.argilla.io/latest/getting_started/quickstart/).
         | 
| @@ -110,3 +112,19 @@ Argilla is a open source tool for data curation. It allows you to annotate and r | |
| 110 | 
             
            Each pipeline is based on distilabel, so you can easily change the LLM or the pipeline steps.
         | 
| 111 |  | 
| 112 | 
             
            Check out the [distilabel library](https://github.com/argilla-io/distilabel) for more information.
         | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | 
|  | |
| 78 | 
             
            pip install synthetic-dataset-generator
         | 
| 79 | 
             
            ```
         | 
| 80 |  | 
| 81 | 
            +
            ### Quickstart
         | 
| 82 | 
            +
             | 
| 83 | 
            +
            ```python
         | 
| 84 | 
            +
            from synthetic_dataset_generator.app import demo
         | 
| 85 | 
            +
             | 
| 86 | 
            +
            demo.launch()
         | 
| 87 | 
            +
            ```
         | 
| 88 | 
            +
             | 
| 89 | 
             
            ### Environment Variables
         | 
| 90 |  | 
| 91 | 
             
            - `HF_TOKEN`: Your [Hugging Face token](https://huggingface.co/settings/tokens/new?ownUserPermissions=repo.content.read&ownUserPermissions=repo.write&globalPermissions=inference.serverless.write&tokenType=fineGrained) to push your datasets to the Hugging Face Hub and generate free completions from Hugging Face Inference Endpoints.
         | 
|  | |
| 101 | 
             
            - `ARGILLA_API_KEY`: Your Argilla API key to push your datasets to Argilla.
         | 
| 102 | 
             
            - `ARGILLA_API_URL`: Your Argilla API URL to push your datasets to Argilla.
         | 
| 103 |  | 
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
| 104 | 
             
            ### Argilla integration
         | 
| 105 |  | 
| 106 | 
             
            Argilla is a open source tool for data curation. It allows you to annotate and review datasets, and push curated datasets to the Hugging Face Hub. You can easily get started with Argilla by following the [quickstart guide](https://docs.argilla.io/latest/getting_started/quickstart/).
         | 
|  | |
| 112 | 
             
            Each pipeline is based on distilabel, so you can easily change the LLM or the pipeline steps.
         | 
| 113 |  | 
| 114 | 
             
            Check out the [distilabel library](https://github.com/argilla-io/distilabel) for more information.
         | 
| 115 | 
            +
             | 
| 116 | 
            +
            ## Development
         | 
| 117 | 
            +
             | 
| 118 | 
            +
            Install the dependencies:
         | 
| 119 | 
            +
             | 
| 120 | 
            +
            ```bash
         | 
| 121 | 
            +
            python -m venv .venv
         | 
| 122 | 
            +
            source .venv/bin/activate
         | 
| 123 | 
            +
            pip install -e .
         | 
| 124 | 
            +
            ```
         | 
| 125 | 
            +
             | 
| 126 | 
            +
            Run the app:
         | 
| 127 | 
            +
             | 
| 128 | 
            +
            ```bash
         | 
| 129 | 
            +
            python app.py
         | 
| 130 | 
            +
            ```
         | 
 
			
