Skip to content

Commit b8b9909

Browse files
committed
clean up
1 parent 89db7b4 commit b8b9909

File tree

1 file changed

+0
-33
lines changed

1 file changed

+0
-33
lines changed

src/data_designer/cli/README.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -234,36 +234,3 @@ data-designer config list
234234
# Delete configuration files (with confirmation)
235235
data-designer config reset
236236
```
237-
238-
## Future Enhancements
239-
240-
Potential improvements to consider:
241-
242-
1. **Import/Export**: Bulk import/export of configurations
243-
2. **Validation**: Test provider connections before saving
244-
3. **Templates**: Save and reuse configuration templates
245-
4. **Profiles**: Switch between different configuration sets
246-
5. **Cloud Sync**: Sync configurations across machines
247-
6. **Auto-Discovery**: Detect and suggest available models from providers
248-
249-
## Development Guidelines
250-
251-
When working with the CLI module:
252-
253-
1. **Follow the layers**: Don't bypass layers (e.g., controllers should not directly access repositories)
254-
2. **Type annotations**: All functions must have type hints
255-
3. **Error handling**: Use try/except at controller layer, raise ValueError at service layer
256-
4. **User feedback**: Always provide clear success/error messages
257-
5. **Testing**: Write tests for each layer independently
258-
6. **Documentation**: Update this README when adding new features
259-
260-
## Related Files
261-
262-
- [../../interface/data_designer.py](../../interface/data_designer.py): Main DataDesigner class that uses CLI configurations
263-
- [../../config/models.py](../../config/models.py): ModelConfig and ModelProvider Pydantic models
264-
- [../essentials/\_\_init\_\_.py](../../essentials/__init__.py): User-facing API that imports CLI configurations
265-
266-
## License
267-
268-
SPDX-FileCopyrightText: Copyright (c) 2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
269-
SPDX-License-Identifier: Apache-2.0

0 commit comments

Comments
 (0)